apply_filters_deprecated() WordPress Function
The apply_filters_deprecated() function was introduced in Wordpress 3.0. It allows for applying filters to data before it is saved to the database. This function is deprecated as of Wordpress 3.5.0.
apply_filters_deprecated( string $hook_name, array $args, string $version, string $replacement = '', string $message = '' ) #
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 ), '4.9.0', 'wpdocs_new_filter' );See also
Parameters
- $hook_name
(string)(Required)The name of the filter hook.
- $args
(array)(Required)Array of additional function arguments to be passed to apply_filters().
- $version
(string)(Required)The version of WordPress that deprecated the hook.
- $replacement
(string)(Optional) The hook that should have been used.
Default value: ''
- $message
(string)(Optional) A message regarding the change.
Default value: ''
Source
File: wp-includes/plugin.php
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 );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.6.0 | Introduced. |