HTMLPurifier_Filter Class Reference

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

Inheritance diagram for HTMLPurifier_Filter:

Collaboration diagram for HTMLPurifier_Filter:

Public Member Functions
	preFilter ($html, $config, $context)
	Pre-processor function, handles HTML before HTML Purifier.
	postFilter ($html, $config, $context)
	Post-processor function, handles HTML after HTML Purifier.

Data Fields
	$name
	Name of the filter for identification purposes.

Detailed Description

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.

Note

Methods are not declared abstract as it is perfectly legitimate for an implementation not to want anything to happen on a step

Definition at line 22 of file Filter.php.

Member Function Documentation

HTMLPurifier_Filter::postFilter	(		$html,
			$config,
			$context
	)

Post-processor function, handles HTML after HTML Purifier.

Reimplemented in HTMLPurifier_Filter_YouTube.

Definition at line 40 of file Filter.php.

                                                         {
        return $html;
    }

HTMLPurifier_Filter::preFilter	(		$html,
			$config,
			$context
	)

Pre-processor function, handles HTML before HTML Purifier.

Reimplemented in HTMLPurifier_Filter_ExtractStyleBlocks, and HTMLPurifier_Filter_YouTube.

Definition at line 33 of file Filter.php.

                                                        {
        return $html;
    }

Field Documentation

HTMLPurifier_Filter::$name

Name of the filter for identification purposes.

Definition at line 28 of file Filter.php.

---

The documentation for this class was generated from the following file:

• Services/Html/HtmlPurifier/library/HTMLPurifier/Filter.php