函数文档

wp_admin_bar_sidebar_toggle()

💡 云策文档标注

概述

wp_admin_bar_sidebar_toggle() 是一个 WordPress 函数,用于在管理后台的工具栏中添加一个侧边栏切换按钮。该函数仅在管理界面中生效,通过 WP_Admin_Bar 实例添加节点。

关键要点

  • 函数 wp_admin_bar_sidebar_toggle() 用于添加侧边栏切换按钮到管理工具栏。
  • 它接受一个必需参数 $wp_admin_bar,即 WP_Admin_Bar 实例。
  • 函数内部使用 is_admin() 检查当前是否为管理界面,如果是,则通过 add_node() 方法添加一个节点。
  • 添加的节点 ID 为 'menu-toggle',标题为翻译后的 'Menu',链接为 '#'。
  • 此函数自 WordPress 3.8.0 版本引入。

代码示例

function wp_admin_bar_sidebar_toggle( $wp_admin_bar ) {
    if ( is_admin() ) {
        $wp_admin_bar->add_node(
            array(
                'id'    => 'menu-toggle',
                'title' => '' .
                        /* translators: Hidden accessibility text. */
                        __( 'Menu' ) .
                    '',
                'href'  => '#',
            )
        );
    }
}

注意事项

  • 此函数仅在管理界面(is_admin() 返回 true)中执行,确保不会在前端添加不必要的工具栏元素。
  • 节点标题使用 __() 函数进行翻译,支持国际化。
  • 相关函数包括 WP_Admin_Bar::add_node()、__() 和 is_admin(),开发者应熟悉这些函数的使用。

📄 原文内容

Adds the sidebar toggle button.

Parameters

$wp_admin_barWP_Admin_Barrequired
The WP_Admin_Bar instance.

Source

function wp_admin_bar_sidebar_toggle( $wp_admin_bar ) {
	if ( is_admin() ) {
		$wp_admin_bar->add_node(
			array(
				'id'    => 'menu-toggle',
				'title' => '<span class="ab-icon" aria-hidden="true"></span><span class="screen-reader-text">' .
						/* translators: Hidden accessibility text. */
						__( 'Menu' ) .
					'</span>',
				'href'  => '#',
			)
		);
	}
}

Changelog

Version Description
3.8.0 Introduced.