wp_admin_bar_site_menu( WP_Admin_Bar $wp_admin_bar )

Compatibility

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_site_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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

5–111

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

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

• optionoption read or writeget_option()one call below wp_admin_bar_site_menu()
• hookthird-party callbacksapply_filters()one call below wp_admin_bar_site_menu()

Further down the call graph this can also reach query, 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 · 254 distinct outcomes

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

Uses · 19

• is_user_logged_in()Determines whether the current visitor is a logged in user.
• is_user_member_of_blog()Finds out whether a user is a member of a given blog.
• current_user_can()Returns whether the current user has the specified capability.
• get_bloginfo()Retrieves information about the current site.
• get_home_url()Retrieves the URL for a given site where the front end is accessible.
• is_network_admin()Determines whether the current request is for the network administrative interface.
• __()Retrieves the translation of $text.
• esc_html()Escaping for HTML blocks.
• get_network()Retrieves network data given a network ID or network object.
• is_user_admin()Determines whether the current request is for a user admin screen.
• wp_html_excerpt()Safely extracts not more than the first $count characters from HTML string.
• is_admin()Determines whether the current request is for an administrative interface page.

Source code

View on Trac ↗View on GitHub ↗

362function wp_admin_bar_site_menu( $wp_admin_bar ) {363	// Don't show for logged out users.364	if ( ! is_user_logged_in() ) {365		return;366	}367 368	// Show only when the user is a member of this site, or they're a super admin.369	if ( ! is_user_member_of_blog() && ! current_user_can( 'manage_network' ) ) {370		return;371	}372 373	$blogname = get_bloginfo( 'name' );374 375	if ( ! $blogname ) {376		$blogname = preg_replace( '#^(https?://)?(www\.)?#', '', get_home_url() );377	}378 379	if ( is_network_admin() ) {380		/* translators: %s: Site title. */381		$blogname = sprintf( __( 'Network Admin: %s' ), esc_html( get_network()->site_name ) );382	} elseif ( is_user_admin() ) {383		/* translators: %s: Site title. */384		$blogname = sprintf( __( 'User Dashboard: %s' ), esc_html( get_network()->site_name ) );385	}386 387	$title = wp_html_excerpt( $blogname, 40, '…' );388 389	$wp_admin_bar->add_node(390		array(391			'id'    => 'site-name',392			'title' => $title,393			'href'  => ( is_admin() || ! current_user_can( 'read' ) ) ? home_url( '/' ) : admin_url(),394			'meta'  => array(395				'menu_title' => $title,396			),397		)398	);399 400	// Create submenu items.401 402	if ( is_admin() ) {403		// Add an option to visit the site.404		$wp_admin_bar->add_node(405			array(406				'parent' => 'site-name',407				'id'     => 'view-site',408				'title'  => __( 'Visit Site' ),409				'href'   => home_url( '/' ),410			)411		);412 413		if ( is_blog_admin() && is_multisite() && current_user_can( 'manage_sites' ) ) {414			$wp_admin_bar->add_node(415				array(416					'parent' => 'site-name',417					'id'     => 'edit-site',418					'title'  => __( 'Manage Site' ),419					'href'   => network_admin_url( 'site-info.php?id=' . get_current_blog_id() ),420				)421			);422		}423	} elseif ( current_user_can( 'read' ) ) {424		// We're on the front end, link to the Dashboard.425		$wp_admin_bar->add_node(426			array(427				'parent' => 'site-name',428				'id'     => 'dashboard',429				'title'  => __( 'Dashboard' ),430				'href'   => admin_url(),431			)432		);433 434		// Add the appearance submenu items.435		wp_admin_bar_appearance_menu( $wp_admin_bar );436 437		// Add a Plugins link.438		if ( current_user_can( 'activate_plugins' ) ) {439			$wp_admin_bar->add_node(440				array(441					'parent' => 'site-name',

Changelog

Introduced in 3.3.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/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.