Public Member Functions
	__construct ($config=null)

	addFilter ($filter)

	purify ($html, $config=null)

	purifyArray ($array_of_html, $config=null)

Static Public Member Functions
static	instance ($prototype=null)

static	getInstance ($prototype=null)

Public Attributes
	$version = '4.12.0'

const	VERSION = '4.12.0'

	$config

	$context

Protected Attributes
	$strategy

	$generator

Detailed Description

Facade that coordinates HTML Purifier's subsystems in order to purify HTML.

Note

There are several points in which configuration can be specified for HTML Purifier. The precedence of these (from lowest to highest) is as follows:

Instance: new HTMLPurifier($config)
Invocation: purify($html, $config) These configurations are entirely independent of each other and are not merged (this behavior may change in the future).

Definition at line 74 of file HTMLPurifier.standalone.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLPurifier::__construct ( $config = null )

Initializes the purifier.

Parameters

HTMLPurifier_Config | mixed $config Optional HTMLPurifier_Config object for all instances of the purifier, if omitted, a default configuration is supplied (which can be overridden on a per-use basis). The parameter can also be any type that HTMLPurifier_Config::create() supports.

Definition at line 134 of file HTMLPurifier.standalone.php.

Member Function Documentation

◆ addFilter()

HTMLPurifier::addFilter ( $filter )

Adds a filter to process the output. First come first serve

Parameters

HTMLPurifier_Filter $filter HTMLPurifier_Filter object

Definition at line 145 of file HTMLPurifier.standalone.php.

◆ getInstance()

static HTMLPurifier::getInstance ( $prototype = null )

static

Singleton for enforcing just one HTML Purifier in your system

Parameters

HTMLPurifier | HTMLPurifier_Config $prototype Optional prototype HTMLPurifier instance to overload singleton with, or HTMLPurifier_Config instance to configure the generated version with.

Returns: HTMLPurifier

Note: Backwards compatibility, see instance()

Definition at line 310 of file HTMLPurifier.standalone.php.

◆ instance()

static HTMLPurifier::instance ( $prototype = null )

static

Singleton for enforcing just one HTML Purifier in your system

Parameters

HTMLPurifier | HTMLPurifier_Config $prototype Optional prototype HTMLPurifier instance to overload singleton with, or HTMLPurifier_Config instance to configure the generated version with.

Returns: HTMLPurifier

Definition at line 285 of file HTMLPurifier.standalone.php.

◆ purify()

HTMLPurifier::purify	(	$html,
		$config = `null`
	)

Filters an HTML snippet/document to be XSS-free and standards-compliant.

Parameters

string	$html	String of HTML to purify
HTMLPurifier_Config	$config	Config object for this operation, if omitted, defaults to the config object specified during this object's construction. The parameter can also be any type that HTMLPurifier_Config::create() supports.

Returns: string Purified HTML

Definition at line 166 of file HTMLPurifier.standalone.php.

◆ purifyArray()

HTMLPurifier::purifyArray	(	$array_of_html,
		$config = `null`
	)

Filters an array of HTML snippets

Parameters

string[]	$array_of_html	Array of html snippets
HTMLPurifier_Config	$config	Optional config object for this operation. See HTMLPurifier::purify() for more details.