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

Uses

Uses Description
wp-includes/functions.php: _deprecated_hook()

Marks a deprecated action or filter hook as deprecated and throws a notice.
wp-includes/plugin.php: has_filter()

Checks if any filter has been registered for a hook.
wp-includes/plugin.php: apply_filters_ref_array()

Calls the callback functions that have been added to a filter hook, specifying arguments in an array.

Used By

Used By Description
wp-includes/block-editor.php: get_block_editor_settings()

Returns the contextualized block editor settings settings for a selected editor context.
wp-includes/block-editor.php: block_editor_rest_api_preload()

Preloads common data used with the block editor by specifying an array of REST API paths that will be preloaded for a given block editor context.
wp-includes/block-editor.php: get_allowed_block_types()

Gets the list of allowed block types to use in the block editor.
wp-includes/block-editor.php: get_block_categories()

Returns all the categories for block types that will be shown in the block editor.
wp-includes/user.php: _wp_privacy_send_request_confirmation_notification()

Notify the site administrator via email when a request is confirmed.
wp-includes/user.php: _wp_privacy_send_erasure_fulfillment_notification()

Notify the user when their erasure request is fulfilled.
wp-admin/includes/class-wp-privacy-policy-content.php: WP_Privacy_Policy_Content::get_default_content()

Return the default suggested privacy policy content.
wp-includes/class-wp-site.php: WP_Site::get_details()

Retrieves the details for this site.
wp-includes/rest-api/class-wp-rest-server.php: WP_REST_Server::serve_request()

Handles serving a REST API request.
wp-login.php: login_header()

Output the login page header.
wp-signup.php: validate_another_blog_signup()

Validate a new site signup for an existing user.
wp-admin/includes/class-wp-screen.php: WP_Screen::render_screen_meta()

Render the screen’s help section.
wp-admin/includes/image-edit.php: wp_save_image_file()

Saves image to file.
wp-admin/includes/image-edit.php: image_edit_apply_changes()

Performs group of changes on Editor specified.
wp-admin/includes/image-edit.php: wp_stream_image()

Streams image in WP_Image_Editor to browser.
wp-admin/includes/media.php: media_buttons()

Adds the media button to the editor
wp-admin/includes/class-wp-terms-list-table.php: WP_Terms_List_Table::prepare_items()
wp-includes/capabilities.php: map_meta_cap()

Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked.
wp-includes/class-wp.php: WP::build_query_string()

Sets the query string property based off of the query variable property.
wp-includes/post.php: get_posts_by_author_sql()

Retrieve the post SQL based on capability, author, and type.
wp-includes/class-wp-rewrite.php: WP_Rewrite::mod_rewrite_rules()

Retrieves mod_rewrite-formatted rewrite rules to write to .htaccess.
wp-includes/class-wp-rewrite.php: WP_Rewrite::rewrite_rules()

Constructs rewrite matches and queries from permalink structure.
wp-includes/ms-blogs.php: get_blog_details()

Retrieve the details for a blog from the blogs table and blog options.
wp-includes/class-wp-editor.php: _WP_Editors::editor()

Outputs the HTML for a single instance of the editor.

Changelog

Version Description
4.6.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/apply_filters_deprecated