Class HTMLPurifier_Filter

InheritanceHTMLPurifier_Filter
SubclassesHTMLPurifier_Filter_ExtractStyleBlocks, HTMLPurifier_Filter_YouTube

Represents a pre or post processing filter on HTML Purifier's output

Sometimes, a little ad-hoc fixing of HTML has to be done before it gets sent through HTML Purifier: you can use filters to acheive this effect. For instance, YouTube videos can be preserved using this manner. You could have used a decorator for this task, but PHP's support for them is not terribly robust, so we're going to just loop through the filters.

Filters should be exited first in, last out. If there are three filters, named 1, 2 and 3, the order of execution should go 1->preFilter, 2->preFilter, 3->preFilter, purify, 3->postFilter, 2->postFilter, 1->postFilter.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$name Name of the filter for identification purposes. HTMLPurifier_Filter

Public Methods

Hide inherited methods

MethodDescriptionDefined By
postFilter() Post-processor function, handles HTML after HTML Purifier HTMLPurifier_Filter
preFilter() Pre-processor function, handles HTML before HTML Purifier HTMLPurifier_Filter

Property Details

$name public property
public $name null

Method Details

postFilter() public method

Post-processor function, handles HTML after HTML Purifier

public string postFilter ( $html, $config, $context )
$html string
$config HTMLPurifier_Config
$context HTMLPurifier_Context
preFilter() public method

Pre-processor function, handles HTML before HTML Purifier

public string preFilter ( $html, $config, $context )
$html string
$config HTMLPurifier_Config
$context HTMLPurifier_Context