apply_filters_deprecated( string $hook_name, array $args, string $version, string $replacement = '', string $message = '' ): mixed

Fires functions attached to a deprecated filter hook.


When a filter hook is deprecated, the apply_filters() call is replaced with apply_filters_deprecated() , which triggers a deprecation notice and then fires the original filter hook.

Note: the value and extra arguments passed to the original apply_filters() call must be passed here to $args as an array. For example:

// Old filter.
return apply_filters( 'wpdocs_filter', $value, $extra_arg );

// Deprecated.
return apply_filters_deprecated( 'wpdocs_filter', array( $value, $extra_arg ), '4.9.0', 'wpdocs_new_filter' );

Top ↑

See also

Top ↑


$hook_name string Required
The name of the filter hook.
$args array Required
Array of additional function arguments to be passed to apply_filters() .
More Arguments from apply_filters( ... $args ) Additional parameters to pass to the callback functions.
$version string Required
The version of WordPress that deprecated the hook.
$replacement string Optional
The hook that should have been used.

Default: ''

$message string Optional
A message regarding the change.

Default: ''

Top ↑


mixed The filtered value after all hooked functions are applied to it.

Top ↑


File: wp-includes/plugin.php. View all references

function apply_filters_deprecated( $hook_name, $args, $version, $replacement = '', $message = '' ) {
	if ( ! has_filter( $hook_name ) ) {
		return $args[0];

	_deprecated_hook( $hook_name, $version, $replacement, $message );

	return apply_filters_ref_array( $hook_name, $args );

Top ↑


Version Description
4.6.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.