mirrors/htmlpurifier
0
0
Fork 0
mirror of https://github.com/ezyang/htmlpurifier.git synced 2025-01-05 06:01:52 +00:00
Code Releases Activity

Add a little bit of documentation about contexts for URIFilters.

Browse Source 
Signed-off-by: Edward Z. Yang <ezyang@mit.edu>
This commit is contained in:
Edward Z. Yang 2011-12-25 03:57:15 -05:00
parent 9b10515fa4
commit bfe2c10d07
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
library/HTMLPurifier/URIFilter.php
View File

@ -6,6 +6,18 @@
* These filters can perform custom actions on a URI filter object, * These filters can perform custom actions on a URI filter object,
* including transformation or blacklisting. * including transformation or blacklisting.
* *
* 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)
*
* @warning This filter is called before scheme object validation occurs. * @warning This filter is called before scheme object validation occurs.
* Make sure, if you require a specific scheme object, you * Make sure, if you require a specific scheme object, you
* you check that it exists. This allows filters to convert * you check that it exists. This allows filters to convert