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

• _deprecated_hook()

Parameters

$hook_namestringrequired

The name of the filter hook.

$argsarrayrequired

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.

$versionstringrequired

The version of WordPress that deprecated the hook.

$replacementstringoptional

The hook that should have been used.

Default:''

$messagestringoptional

A message regarding the change.

Default:''

Return

Source

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

View all references View on Trac View on GitHub

Changelog