apply_filters_deprecated( string $hook_name, array $args, string $version, string $replacement = '', string $message = '' ): mixed
Fires functions attached to a deprecated filter hook.
Contents
Description
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' );See also
Parameters
-
$hook_namestring Required -
The name of the filter hook.
-
$argsarray 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. -
$versionstring Required -
The version of WordPress that deprecated the hook.
-
$replacementstring Optional -
The hook that should have been used.
Default:
'' -
$messagestring Optional -
A message regarding the change.
Default:
''
Return
mixed The filtered value after all hooked functions are applied to it.
Source
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 );
}
Changelog
| Version | Description |
|---|---|
| 4.6.0 | Introduced. |