MarkupHTMLPurifier class

Front-end to the HTML Purifier library.

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.

Show class?             Show args?        

Common

NameReturnSummary 
clearCache()
(nothing)Clear the HTML Purifier cache 
get(string $key)
string nullGet an HTMLPurifier config option 
getConfig()
HTMLPurifier_Config nullReturn the current settings 
getDef()
HTMLPurifier_HTMLDefinition nullGet HTML Purifier raw HTML definition 
getPurifier()
HTMLPurifierGet the HTMLPurifier instance 
initConfig(\HTMLPurifier_Config $settings, \HTMLPurifier_HTMLDefinition $def)
(nothing)
purify($html)
stringPurify the given dirty HTML and return the clean HTML 
set(string $key, $value)
WireData MarkupHTMLPurifierSet 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.244

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer