wppaste
WordPress

wp_admin_bar_comments_menu( WP_Admin_Bar $wp_admin_bar )

Since
3.1.0
Source
wp-includes/admin-bar.php:1122
Adds edit comments link with awaiting moderation count bubble.

Compatibility

WordPress
since 3.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

$wp_admin_barWP_Admin_Bar
The WP_Admin_Bar instance.

Performance profile

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

Only touches the object cache, via wp_cache_get().

Scaling
Constant

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

Instructions
6–44

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

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

What it touches

  • hookthird-party callbacksapply_filters()one call below wp_admin_bar_comments_menu()
  • cacheobject cachewp_cache_get()one call below wp_admin_bar_comments_menu()

Further down the call graph this can also reach query, option, 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 wp_admin_bar_comments_menu() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
!current_user_can()6current_user_can()
current_user_can()44current_user_can(), wp_count_comments(), _n(), number_format_i18n(), sprintf(), number_format_i18n(), admin_url(), comments()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 45 instructions, 6–44 executed per call, 1 branch. 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 · 5

  • current_user_can()Returns whether the current user has the specified capability.
  • wp_count_comments()Retrieves the total comment counts for the whole site or a single post.
  • _n()Translates and retrieves the singular or plural form based on the supplied number.
  • number_format_i18n()Converts float number to format based on the locale.
  • admin_url()Retrieves the URL to the admin area for the current site.

Source code

View on Trac View on GitHub 

function wp_admin_bar_comments_menu( $wp_admin_bar ) {	if ( ! current_user_can( 'edit_posts' ) ) {		return;	} 	$awaiting_mod  = wp_count_comments();	$awaiting_mod  = $awaiting_mod->moderated;	$awaiting_text = sprintf(		/* translators: Hidden accessibility text. %s: Number of comments. */		_n( '%s Comment in moderation', '%s Comments in moderation', $awaiting_mod ),		number_format_i18n( $awaiting_mod )	); 	$icon   = '<span class="ab-icon" aria-hidden="true"></span>';	$title  = '<span class="ab-label awaiting-mod pending-count count-' . $awaiting_mod . '" aria-hidden="true">' . number_format_i18n( $awaiting_mod ) . '</span>';	$title .= '<span class="screen-reader-text comments-in-moderation-text">' . $awaiting_text . '</span>'; 	$wp_admin_bar->add_node(		array(			'id'    => 'comments',			'title' => $icon . $title,			'href'  => admin_url( 'edit-comments.php' ),		)	);}

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.1.0 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.