\HTMLPurifier_Filter

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.

Summary

Methods
Properties
Constants
preFilter()
postFilter()
$name
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$name

$name

Name of the filter for identification purposes.

Methods

preFilter()

preFilter(string  $html, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : string

Pre-processor function, handles HTML before HTML Purifier

Parameters

string $html
\HTMLPurifier_Config $config
\HTMLPurifier_Context $context

Returns

string —

postFilter()

postFilter(string  $html, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : string

Post-processor function, handles HTML after HTML Purifier

Parameters

string $html
\HTMLPurifier_Config $config
\HTMLPurifier_Context $context

Returns

string —