A WordPress-centric search engine for devs and theme authors



apply_filters_deprecated ›

Since4.6.0
Deprecatedn/a
apply_filters_deprecated ( $tag, $args, $version, $replacement = false, $message = null )
Parameters: (5)
  • (string) $tag The name of the filter hook.
    Required: Yes
  • (array) $args Array of additional function arguments to be passed to apply_filters().
    Required: Yes
  • (string) $version The version of WordPress that deprecated the hook.
    Required: Yes
  • (string) $replacement Optional. The hook that should have been used. Default false.
    Required: No
    Default: false
  • (string) $message Optional. A message regarding the change. Default null.
    Required: No
    Default: null
See:
Defined at:
Codex:

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', 'wpdocs_new_filter' );


Source

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 );
}