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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$hook_namestring

The name of the action hook.

$argsarray

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

$versionstring

The version of WordPress that deprecated the hook.

$replacementstringoptional

The hook that should have been used. Default empty.Default: ''

$messagestringoptional

A message regarding the change. Default empty.Default: ''

Performance profile

How much work a call to do_action_deprecated() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

10–20

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 21.

Plugin surface

1 hook

Third-party callbacks on '{$hook_name}' run inside this call, and their cost is not bounded by anything here.

Called by

10

10 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action_deprecated()this function does it

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost do_action_deprecated() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while do_action_deprecated() runs, in this order:

1. 1
   apply_filters( {$hook_name} )filterline 746 (+7 into the body)

Uses · 3

• has_action()Checks if any action has been registered for a hook.
• _deprecated_hook()Marks a deprecated action or filter hook as deprecated and throws a notice.
• do_action_ref_array()Calls the callback functions that have been added to an action hook, specifying arguments in an array.

Used by · 10

• _transition_post_status()Hook for managing future post transitions to published.
• clean_blog_cache()Clean the blog cache
• get_password_reset_key()Creates, stores, then returns a password reset key for user.
• register_and_do_post_meta_boxes()Registers the default post meta boxes, and runs the `do_meta_boxes` actions.
• set_site_transient()Sets/updates the value of a site transient.
• set_transient()Sets/updates the value of a transient.
• wp_check_comment_disallowed_list()Checks if a comment contains disallowed characters or words.
• wp_delete_site()Deletes a site from the database.
• wp_insert_site()Inserts a new site into the database.
• wpmu_delete_blog()Deletes a site.

Source code

View on Trac ↗View on GitHub ↗

739function do_action_deprecated( $hook_name, $args, $version, $replacement = '', $message = '' ) {740	if ( ! has_action( $hook_name ) ) {741		return;742	}743 744	_deprecated_hook( $hook_name, $version, $replacement, $message );745 746	do_action_ref_array( $hook_name, $args );747}

Changelog

Introduced in 4.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/plugin.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.