wp_admin_bar_render()

Description

Compatibility

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

Performance profile

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

4–23

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

Plugin surface

3 hooks

Third-party callbacks on 'admin_bar_menu', 'wp_before_admin_bar_render', 'wp_after_admin_bar_render' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action_ref_array()called directly

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 · 3 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while wp_admin_bar_render() runs, in this order:

1. 1
   do_action( admin_bar_menu )actionline 97 (+24 into the body)

   Loads all necessary admin bar items.

2. 2
   do_action( wp_before_admin_bar_render )actionline 104 (+31 into the body)

   Fires before the admin bar is rendered.

3. 3
   do_action( wp_after_admin_bar_render )actionline 113 (+40 into the body)

   Fires after the admin bar is rendered.

Uses · 3

• is_admin_bar_showing()Determines whether the admin bar should be showing.
• do_action_ref_array()Calls the callback functions that have been added to an action hook, specifying arguments in an array.
• do_action()Calls the callback functions that have been added to an action hook.

Source code

View on Trac ↗View on GitHub ↗

73function wp_admin_bar_render() {74	global $wp_admin_bar;75	static $rendered = false;76 77	if ( $rendered ) {78		return;79	}80 81	if ( ! is_admin_bar_showing() || ! is_object( $wp_admin_bar ) ) {82		return;83	}84 85	/**86	 * Loads all necessary admin bar items.87	 *88	 * This hook can add, remove, or manipulate admin bar items. The priority89	 * determines the placement for new items, and changes to existing items90	 * would require a high priority. To remove or manipulate existing nodes91	 * without a specific priority, use `wp_before_admin_bar_render`.92	 *93	 * @since 3.1.094	 *95	 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance, passed by reference.96	 */97	do_action_ref_array( 'admin_bar_menu', array( &$wp_admin_bar ) );98 99	/**100	 * Fires before the admin bar is rendered.101	 *102	 * @since 3.1.0103	 */104	do_action( 'wp_before_admin_bar_render' );105 106	$wp_admin_bar->render();107 108	/**109	 * Fires after the admin bar is rendered.110	 *111	 * @since 3.1.0112	 */113	do_action( 'wp_after_admin_bar_render' );114 115	$rendered = true;116}

Changelog

Introduced in 3.1.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 7.0.4 tag, from src/wp-includes/admin-bar.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.