$name
$name
Unique identifier of filter.
Chainable filters for custom URI processing.
These filters can perform custom actions on a URI filter object, including transformation or blacklisting. A filter named Foo must have a corresponding configuration directive %URI.Foo, unless always_load is specified to be true.
The following contexts may be available while URIFilters are being processed:
- EmbeddedURI: true if URI is an embedded resource that will
be loaded automatically on page load
- CurrentToken: a reference to the token that is currently
being processed
- CurrentAttr: the name of the attribute that is currently being
processed
- CurrentCSSProperty: the name of the CSS property that is
currently being processed (if applicable)
filter(\HTMLPurifier_URI $uri, \HTMLPurifier_Config $config, \HTMLPurifier_Context $context) : bool
Filter a URI object
\HTMLPurifier_URI | $uri | Reference to URI object variable |
\HTMLPurifier_Config | $config | |
\HTMLPurifier_Context | $context |
Whether or not to continue processing: false indicates URL is no good, true indicates continue processing. Note that all changes are committed directly on the URI object