do_action_deprecated( string $hook_name, array $args, string $version, string $replacement = '', string $message = '' )

Fires functions attached to a deprecated action hook.

Description

When an action hook is deprecated, the do_action() call is replaced with do_action_deprecated(), which triggers a deprecation notice and then fires the original hook.

See also

Parameters

$hook_name

(string) (Required) The name of the action hook.

$args

(array) (Required) Array of additional function arguments to be passed to do_action().

$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 do_action_deprecated( $hook_name, $args, $version, $replacement = '', $message = '' ) {
	if ( ! has_action( $hook_name ) ) {
		return;
	}

	_deprecated_hook( $hook_name, $version, $replacement, $message );

	do_action_ref_array( $hook_name, $args );
}

Changelog

Version Description
4.6.0 Introduced.

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