apply_filters_deprecated( string $tag, array $args, string $version, string $replacement = false, string $message = null )
Fires functions attached to a deprecated filter hook.
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 ), 'WP-4.9', 'wpdocs_new_filter' );See also
Parameters
- $tag
-
(Required) The name of the filter hook.
- $args
-
(Required) Array of additional function arguments to be passed to apply_filters().
- $version
-
(Required) The version of ClassicPress or WordPress that deprecated the hook.
- $replacement
-
(Optional) The hook that should have been used.
Default value: false
- $message
-
(Optional) A message regarding the change.
Default value: null
Source
File: wp-includes/plugin.php
function apply_filters_deprecated( $tag, $args, $version, $replacement = false, $message = null ) {
if ( ! has_filter( $tag ) ) {
return $args[0];
}
_deprecated_hook( $tag, $version, $replacement, $message );
return apply_filters_ref_array( $tag, $args );
}
Changelog
| Version | Description |
|---|---|
| WP-4.6.0 | Introduced. |