do_action_ref_array( string $hook_name, array $args )
- Since
- 2.1.0
- Source
wp-includes/plugin.php:543
Compatibility
- WordPress
- since 2.1.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
$hook_namestring- The name of the action to be executed.
$argsarray- The arguments supplied to the functions hooked to
$hook_name.
Performance profile
How much work a call to do_action_ref_array() 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
- Scaling
- Constant
- Instructions
- 16–32
- Plugin surface
- None
- Called by
- 32
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 40.
Nothing here hands control to plugin code.
32 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action_ref_array()this function does it
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost do_action_ref_array() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!isset($wp_filter) && !isset($wp_filter[$hook_name]) | 16–17 | none |
!isset($wp_filter[$hook_name]) | 19–20 | array_pop() |
!isset($wp_filter[$hook_name]) | 22–23 | _wp_call_all_hook() |
!isset($wp_filter) && isset($wp_filter[$hook_name]) | 23–26 | ->do_action(), array_pop() |
isset($wp_filter) && !isset($wp_filter[$hook_name]) | 25–26 | _wp_call_all_hook(), array_pop() |
isset($wp_filter) && isset($wp_filter[$hook_name]) | 29–32 | _wp_call_all_hook(), ->do_action(), array_pop() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 40 instructions, 16–32 executed per call, 5 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.
Uses · 1
- _wp_call_all_hook()Calls the 'all' hook, which will process the functions hooked into it.
Used by · 32
- WP::main()Sets up all of the variables required by the WordPress environment.
- WP::parse_request()Parses the request to find the correct WordPress query.
- WP::send_headers()Sends additional HTTP headers for caching, content type, etc.
- WP_Comment_Query::get_comments()Get a list of comments matching the query vars.
- WP_Comment_Query::parse_query()Parse arguments passed to the comment query with default query parameters.
- WP_HTTP_Requests_Hooks::dispatch()Dispatch a Requests hook to a native WordPress action.
- WP_Http_Curl::request()Send a HTTP request to a URI using cURL extension.
- WP_Network_Query::get_networks()Gets a list of networks matching the query vars.
- WP_Network_Query::parse_query()Parses arguments passed to the network query with default query parameters.
- WP_Query::get_posts()Retrieves an array of posts based on query variables.
- WP_Query::have_posts()Determines whether there are more posts available in the loop.
- WP_Query::parse_query()Parses a query string and sets query type booleans.
Show all 32
- WP_Query::set_404()Sets the 404 property and saves whether query is feed.
- WP_Query::setup_postdata()Sets up global post data.
- WP_Query::the_post()Sets up the current post.
- WP_REST_Widget_Types_Controller::get_widget_form()Returns the output of WP_Widget::form() when called with the provided instance. Used by encode_form_data() to preview a widget's form.
- WP_Rewrite::rewrite_rules()Constructs rewrite matches and queries from permalink structure.
- WP_Scripts::init()Initialize the class.
- WP_Site_Query::get_sites()Retrieves a list of sites matching the query vars.
- WP_Site_Query::parse_query()Parses arguments passed to the site query with default query parameters.
- WP_Styles::__construct()Constructor.
- WP_Term_Query::get_terms()Retrieves the query results.
- WP_User_Query::prepare_query()Prepares the query variables.
- WP_User_Search::prepare_query()Prepares the user search query (legacy).
- WP_Widget::form_callback()Generates the widget control form (Do NOT override).
- do_action_deprecated()Fires functions attached to a deprecated action hook.
- edit_user()Edit user settings based on contents of $_POST
- fetch_feed()Builds SimplePie object based on RSS or Atom feed from URL.
- pingback()Pings back the links found in a post.
- wp_admin_bar_render()Renders the admin bar to the page based on the $wp_admin_bar->menu member var.
- wp_mail()Sends an email, similar to PHP's mail function.
- wp_signon()Authenticates and logs a user in with 'remember' capability.
Source code
function do_action_ref_array( $hook_name, $args ) { global $wp_filter, $wp_actions, $wp_current_filter; if ( ! isset( $wp_actions[ $hook_name ] ) ) { $wp_actions[ $hook_name ] = 1; } else { ++$wp_actions[ $hook_name ]; } // Do 'all' actions first. if ( isset( $wp_filter['all'] ) ) { $wp_current_filter[] = $hook_name; $all_args = func_get_args(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection _wp_call_all_hook( $all_args ); } if ( ! isset( $wp_filter[ $hook_name ] ) ) { if ( isset( $wp_filter['all'] ) ) { array_pop( $wp_current_filter ); } return; } if ( ! isset( $wp_filter['all'] ) ) { $wp_current_filter[] = $hook_name; } $wp_filter[ $hook_name ]->do_action( $args ); array_pop( $wp_current_filter );}Changelog
Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 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.