is_admin_bar_showing(): bool

Description

Compatibility

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

Return value

bool

Whether the admin bar should be showing.

Performance profile

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

5–33

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

Plugin surface

1 hook

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

Called by

4

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

What it touches

• hookthird-party callbacksapply_filters()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 · 7 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while is_admin_bar_showing() runs, in this order:

1. 1
   apply_filters( show_admin_bar )filterline 1378 (+35 into the body)

   Filters whether to show the admin bar.

Uses · 6

• wp_is_json_request()Checks whether current request is a JSON request, or is expecting a JSON response.
• is_embed()Is the query for an embedded post?
• is_admin()Determines whether the current request is for an administrative interface page.
• is_user_logged_in()Determines whether the current visitor is a logged in user.
• _get_admin_bar_pref()Retrieves the admin bar display preference of a user.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 4

• _wp_admin_bar_init()Instantiates the admin bar object and set it up as a global for access elsewhere.
• _wp_admin_html_begin()Prints out the beginning of the admin HTML header.
• get_body_class()Retrieves an array of the class names for the body element.
• wp_admin_bar_render()Renders the admin bar to the page based on the $wp_admin_bar->menu member var.

Source code

View on Trac ↗View on GitHub ↗

1343function is_admin_bar_showing() {1344	global $show_admin_bar, $pagenow;1345 1346	// For all these types of requests, we never want an admin bar.1347	if ( defined( 'XMLRPC_REQUEST' ) || defined( 'DOING_AJAX' ) || defined( 'IFRAME_REQUEST' ) || wp_is_json_request() ) {1348		return false;1349	}1350 1351	if ( is_embed() ) {1352		return false;1353	}1354 1355	// Integrated into the admin.1356	if ( is_admin() ) {1357		return true;1358	}1359 1360	if ( ! isset( $show_admin_bar ) ) {1361		if ( ! is_user_logged_in() || 'wp-login.php' === $pagenow ) {1362			$show_admin_bar = false;1363		} else {1364			$show_admin_bar = _get_admin_bar_pref();1365		}1366	}1367 1368	/**1369	 * Filters whether to show the admin bar.1370	 *1371	 * Returning false to this hook is the recommended way to hide the admin bar.1372	 * The user's display preference is used for logged in users.1373	 *1374	 * @since 3.1.01375	 *1376	 * @param bool $show_admin_bar Whether the admin bar should be shown. Default false.1377	 */1378	$show_admin_bar = apply_filters( 'show_admin_bar', $show_admin_bar );1379 1380	return $show_admin_bar;1381}

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