云策 WordPress 开发者社区

函数文档

is_admin_bar_showing()

查看官方原文 ↗
💡 云策文档标注

概述

is_admin_bar_showing() 函数用于判断是否应显示管理工具栏，返回布尔值。它基于多种条件（如请求类型、用户登录状态和过滤器）动态决定显示状态。

关键要点

  • 函数返回布尔值，表示管理工具栏是否应显示。
  • 在 XMLRPC_REQUEST、DOING_AJAX、IFRAME_REQUEST、JSON 请求或嵌入页面时自动返回 false。
  • 在管理界面（is_admin()）中始终返回 true。
  • 对于已登录用户，显示偏好通过 _get_admin_bar_pref() 获取；未登录用户或登录页面返回 false。
  • 可通过 show_admin_bar 过滤器钩子自定义显示逻辑，这是推荐的隐藏管理工具栏方式。

代码示例

if ( is_admin_bar_showing() ) {
    // do something
}
📄 原文内容

Determines whether the admin bar should be showing.

Description

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

Return

bool Whether the admin bar should be showing.

Source

function is_admin_bar_showing() {
	global $show_admin_bar, $pagenow;

	// For all these types of requests, we never want an admin bar.
	if ( defined( 'XMLRPC_REQUEST' ) || defined( 'DOING_AJAX' ) || defined( 'IFRAME_REQUEST' ) || wp_is_json_request() ) {
		return false;
	}

	if ( is_embed() ) {
		return false;
	}

	// Integrated into the admin.
	if ( is_admin() ) {
		return true;
	}

	if ( ! isset( $show_admin_bar ) ) {
		if ( ! is_user_logged_in() || 'wp-login.php' === $pagenow ) {
			$show_admin_bar = false;
		} else {
			$show_admin_bar = _get_admin_bar_pref();
		}
	}

	/**
	 * Filters whether to show the admin bar.
	 *
	 * Returning false to this hook is the recommended way to hide the admin bar.
	 * The user's display preference is used for logged in users.
	 *
	 * @since 3.1.0
	 *
	 * @param bool $show_admin_bar Whether the admin bar should be shown. Default false.
	 */
	$show_admin_bar = apply_filters( 'show_admin_bar', $show_admin_bar );

	return $show_admin_bar;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘show_admin_bar’, bool $show_admin_bar )

Filters whether to show the admin bar.

Uses Description
wp_is_json_request()wp-includes/load.php

Checks whether current request is a JSON request, or is expecting a JSON response.
is_embed()wp-includes/query.php

Is the query for an embedded post?
_get_admin_bar_pref()wp-includes/admin-bar.php

Retrieves the admin bar display preference of a user.
is_user_logged_in()wp-includes/pluggable.php

Determines whether the current visitor is a logged in user.
is_admin()wp-includes/load.php

Determines whether the current request is for an administrative interface page.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Show 3 moreShow less

Used by Description
_wp_admin_html_begin()wp-admin/includes/template.php

Prints out the beginning of the admin HTML header.
_wp_admin_bar_init()wp-includes/admin-bar.php

Instantiates the admin bar object and set it up as a global for access elsewhere.
wp_admin_bar_render()wp-includes/admin-bar.php

Renders the admin bar to the page based on the $wp_admin_bar->menu member var.
get_body_class()wp-includes/post-template.php

Retrieves an array of the class names for the body element.

Changelog

Version Description
3.1.0 Introduced.

User Contributed Notes