Define content filters.
User submitted content is passed through a group of filters before it is output in HTML, in order to remove insecure or unwanted parts, correct or enhance the formatting, transform special keywords, etc. A group of filters is referred to as a "text format". Administrators can create as many text formats as needed. Individual filters can be enabled and configured differently for each text format.
This hook is invoked by filter_get_filters() and allows modules to register input filters they provide.
Filtering is a two-step process. First, the content is 'prepared' by calling the 'prepare callback' function for every filter. The purpose of the 'prepare callback' is to escape HTML-like structures. For example, imagine a filter which allows the user to paste entire chunks of programming code without requiring manual escaping of special HTML characters like < or &. If the programming code were left untouched, then other filters could think it was HTML and change it. For many filters, the prepare step is not necessary.
The second step is the actual processing step. The result from passing the text through all the filters' prepare steps gets passed to all the filters again, this time with the 'process callback' function. The process callbacks should then actually change the content: transform URLs into hyperlinks, convert smileys into images, etc.
For performance reasons content is only filtered once; the result is stored in the cache table and retrieved from the cache the next time the same piece of content is displayed. If a filter's output is dynamic, it can override the cache mechanism, but obviously this should be used with caution: having one filter that does not support caching in a particular text format disables caching for the entire format, not just for one filter.
Beware of the filter cache when developing your module: it is advised to set your filter to 'cache' => FALSE while developing, but be sure to remove that setting if it's not needed, when you are no longer in development mode.
An associative array of filters, whose keys are internal filter names, which should be unique and therefore prefixed with the name of the module. Each value is an associative array describing the filter, with the following elements (all are optional except as noted):
- title: (required) An administrative summary of what the filter does.
- description: Additional administrative information about the filter's behavior, if needed for clarification.
- settings callback: The name of a function that returns configuration form elements for the filter. See callback_filter_settings() for details.
- default settings: An associative array containing default settings for the filter, to be applied when the filter has not been configured yet.
- prepare callback: The name of a function that escapes the content before the actual filtering happens. See callback_filter_prepare() for details.
- process callback: (required) The name the function that performs the actual filtering. See callback_filter_process() for details.
- cache (default TRUE): Specifies whether the filtered text can be cached. Note that setting this to FALSE makes the entire text format not cacheable, which may have an impact on the site's overall performance. See filter_format_allowcache() for details.
- tips callback: The name of a function that returns end-user-facing filter usage guidelines for the filter. See callback_filter_tips() for details.
- weight: A default weight for the filter in new text formats.
Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.
filter/ filter.api.php, line 80
- Hooks provided by the Filter module.