HumHub Documentation (unofficial)

HtmlPurifier extends BaseHtmlPurifier
in package

HtmlPurifier provides an ability to clean up HTML from any harmful code.

Basic usage is the following:

echo HtmlPurifier::process($html);

If you want to configure it:

echo HtmlPurifier::process($html, [
    'Attr.EnableID' => true,
]);

For more details please refer to HTMLPurifier documentation.

Tags
author

Alexander Makarov sam@rmcreative.ru

since
2.0

Table of Contents

Methods

process()  : string
Passes markup through HTMLPurifier making it safe to output to end user.
configure()  : mixed
Allow the extended HtmlPurifier class to set some default config options.

Methods

process()

Passes markup through HTMLPurifier making it safe to output to end user.

public static process(string $content[, array<string|int, mixed>|Closure|null $config = null ]) : string
Parameters
$content : string

The HTML content to purify

$config : array<string|int, mixed>|Closure|null = null

The config to use for HtmlPurifier. If not specified or null the default config will be used. You can use an array or an anonymous function to provide configuration options:

  • An array will be passed to the HTMLPurifier_Config::create() method.

  • An anonymous function will be called after the config was created. The signature should be: function($config) where $config will be an instance of HTMLPurifier_Config.

    Here is a usage example of such a function:

    // Allow the HTML5 data attribute `data-type` on `img` elements.
$content = HtmlPurifier::process($content, function ($config) {
  $config->getHTMLDefinition(true)
         ->addAttribute('img', 'data-type', 'Text');
});
Return values
string —

the purified HTML content.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results