wppaste
WordPress

_wp_call_all_hook( array $args )

Since
2.5.0
Source
wp-includes/plugin.php:971
Calls the 'all' hook, which will process the functions hooked into it.

Description

The 'all' hook passes all of the arguments or parameters that were used for the hook, which this function was called for.

This function is used internally for apply_filters(), do_action(), and do_action_ref_array() and is not meant to be used from outside those functions. This function does not check for the existence of the all hook, so it will fail unless the all hook exists prior to this function call.

Compatibility

WordPress
since 2.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$argsarray
The collected parameters from the hook that was called.

Performance profile

How much work a call to _wp_call_all_hook() 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
7

Executed per call on PHP 8.5. The body compiles to 7.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
4

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

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always7->do_all_hook()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 7 instructions, 7 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Used by · 4

  • apply_filters()Calls the callback functions that have been added to a filter hook.
  • apply_filters_ref_array()Calls the callback functions that have been added to a filter hook, specifying arguments in an array.
  • do_action()Calls the callback functions that have been added to an action hook.
  • do_action_ref_array()Calls the callback functions that have been added to an action hook, specifying arguments in an array.

Source code

View on Trac View on GitHub 

function _wp_call_all_hook( $args ) {	global $wp_filter; 	$wp_filter['all']->do_all_hook( $args );}

Changelog

Introduced in 2.5.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.9.7 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.