Function Reference/apply filters

This page redirects to an external site: https://developer.wordpress.org/reference/functions/apply_filters/

Languages: English • Italiano • 日本語 (Add your language)

1 Description
2 Usage
3 Parameters
4 Return
5 Examples
6 Notes
7 Change Log
8 Source File
9 Related

Description

Call the functions added to a filter hook. See the Plugin API for a list of filter hooks.

The callback functions attached to filter hook $tag 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.

Usage

<code style="color: #000000"> <span style="color: #0000BB"><?php apply_filters</span><span style="color: #007700">( </span><span style="color: #0000BB">$tag</span><span style="color: #007700">, </span><span style="color: #0000BB">$value</span><span style="color: #007700">, </span><span style="color: #0000BB">$var </span><span style="color: #007700">... ); </span><span style="color: #0000BB">?></span> </code>

Parameters

$tag

(string) (required) The name of the filter hook.

Default: None

$value

(mixed) (required) The value which can be modified by filters hooked to $tag

Default: None

$var

(mixed) (optional) One or more additional variables passed to the filter functions. You can use this parameter in your function but it will not be returned. This parameter is available since Version 1.5.1.

Default: None

Return

(mixed): The result of $value after all hooked functions are applied to it.

Note: The type of return should be the same as the type of $value: a string or an array, for example.

Examples

Echo after Filtering

echo apply_filters( $tag, $value );

Get Filtered

$myvar = apply_filters( $tag, $value );

Additional Filter Arguments

$myvar = apply_filters( $tag, $value, $param, $otherparam );
For example:
$myvar = apply_filters( 'example_filter', 'filter me', 'arg1', 'arg2 ');

With the_title filter

$my_custom_title = apply_filters('the_title', '  My Custom Title (tm)  ');

$my_custom_title will now contain 'My Custom Title ™', since the_title filter applies wptexturize() and trim(), among others.

Notes

Change Log

Since: 0.71

Source File

apply_filters() is located in wp-includes/plugin.php.

Filter Functions:

See also index of Function Reference and index of Template Tags.

Codex