apply_filters


apply_filters ( $tag, $value )

Parameters:
  • (string) tag The name of the filter hook.
  • (mixed) value The value to filter.
  • (mixed) args Additional parameters to pass to the callback functions.
Returns:
  • (mixed) The filtered value after all hooked functions are applied to it.
Defined at:

Description

Calls the callback functions that have been added to a filter hook.The callback functions attached to the filter hook are invoked by calling this function. This function can be used to create a new filter hook by simply calling this function with the name of the new hook specified using the `$tag` parameter. The function also allows for multiple additional arguments to be passed to hooks. Example usage: // The filter callback function. function example_callback( $string, $arg1, $arg2 ) { // (maybe) modify $string. return $string; } add_filter( 'example_filter', 'example_callback', 10, 3 ); /* * Apply the filters by calling the 'example_callback()' function * that's hooked onto `example_filter` above. * * - 'example_filter' is the filter hook. * - 'filter me' is the value being filtered. * - $arg1 and $arg2 are the additional arguments passed to the callback. $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 );

Related Functions

apply_filters_ref_array, add_filter, apply_filters_deprecated, has_filter, wp_list_filter

Top Google Results

User discussions

wpseek mobile