MarkupHTMLPurifier class

Serves as a front-end to the HTML Purifier software:

USAGE:

$purifier = $modules->get('MarkupHTMLPurifier'); $cleanHTML = $purifier->purify($dirtyHTML);

To specify custom settings to HTML Purifier, perform set() calls before calling purify(). For example, UTF-8 encoding is assumed, so if you wanted ISO-8859-1 instead, you'd do:

$purifier->set('Core.Encoding', 'ISO-8859-1');

For a full list of HTML Purifier config options, see:

HTML Purifier by: http://htmlpurifier.org

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the MarkupHTMLPurifier class also inherits all the methods and properties of: WireData and Wire.

Common

Name	Return	Summary
MarkupHTMLPurifier::clearCache() MarkupHTMLPurifier::clearCache() MarkupHTMLPurifier::clearCache()	None	Clear the HTML Purifier cache
MarkupHTMLPurifier::get() MarkupHTMLPurifier::get(string $key) MarkupHTMLPurifier::get(string $key)	`string` `null`	Get an HTMLPurifier config option
MarkupHTMLPurifier::getConfig() MarkupHTMLPurifier::getConfig() MarkupHTMLPurifier::getConfig()	`HTMLPurifier_Config` `null`	Return the current settings
MarkupHTMLPurifier::getDef() MarkupHTMLPurifier::getDef() MarkupHTMLPurifier::getDef()	`HTMLPurifier_HTMLDefinition` `null`	Get HTML Purifier raw HTML definition
MarkupHTMLPurifier::getPurifier() MarkupHTMLPurifier::getPurifier() MarkupHTMLPurifier::getPurifier()	`HTMLPurifier`	Get the HTMLPurifier instance
MarkupHTMLPurifier::purify() MarkupHTMLPurifier::purify($html) MarkupHTMLPurifier::purify($html)	`string`	Purify the given dirty HTML and return the clean HTML
MarkupHTMLPurifier::set() MarkupHTMLPurifier::set(string $key, $value) MarkupHTMLPurifier::set(string $key, $value)	`WireData` `MarkupHTMLPurifier`	Set an HTMLPurifier config option

Additional methods and properties

In addition to the methods and properties above, MarkupHTMLPurifier also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.251