do_action_deprecated() WordPress Function

The do_action_deprecated() function is used to trigger an action hook that has been deprecated.

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.

Top ↑

See also


Top ↑

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: ''


Top ↑

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


Top ↑

Changelog

Changelog
VersionDescription
4.6.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.