WP_Admin_Bar::add_node()publicWP 3.1.0

Добавляет элемент (ссылку) в Админ бар (верхнее меню на фронте).

Это алиас метода: WP_Admin_Bar::add_menu().

Использовать этот метод нужно на хуке admin_bar_menu.

Читайте также 11 хаков для Админ-бара.

Метод класса: WP_Admin_Bar{}

Работает на основе: WP_Admin_Bar::_set_node()
Основа для: WP_Admin_Bar::add_menu()

Хуков нет.

Возвращает

null. Ничего.

Использование

$WP_Admin_Bar = new WP_Admin_Bar();
$WP_Admin_Bar->add_node( $args );
$args(массив) (обязательный)

Аргументы добавляемого элемента. Массив может содержать следующие ключи:

  • id(строка) (обязательный)
    ID создаваемого элемента панели.

  • title(строка) (обязательный)
    Заголовок/анкор ссылки. Тут можно использовать HTML теги, например чтобы добавить иконку.

  • href(строка) (обязательный)
    УРЛ ссылки.

  • parent(строка)
    ID родительского элемента, к которому подбавляемый элемент должен стать дочерним.
    По умолчанию: false

  • group(логический)
    Является ли ссылка групповой. Принадлежит ли она к какой-либо группе.
    По умолчанию: false

  • meta(массив)
    Дополнительные данные ссылки. Доп. атрибуты тега A. Может быть:

    • html - любой HTML код или просто текст, который будет выведен сразу после тега A.
    • class - атрибут 'class'
    • rel - атрибут 'rel'
    • onclick - атрибут 'onclick'
    • target - как открывать ссылку '_blank' - в новом окне
    • title - атрибут title
    • tabindex - порядок при нажатии на клавишу TAB

    По умолчанию: array()

Примеры

0

#1 Добавим ссылку и дочернюю ссылку в панель

// Добавляет ссылку в админ бар
add_action( 'admin_bar_menu', 'my_admin_bar_menu', 30 );
function my_admin_bar_menu( $wp_admin_bar ){

	$wp_admin_bar->add_menu( array(
		'id'    => 'menu_id',
		'title' => 'Внешняя ссылка',
		'href'  => 'http://example.com',
	) );

	// дочерняя ссылка
	$wp_admin_bar->add_menu( array(
		'parent' => 'menu_id', // параметр id из первой ссылки
		'id'     => 'some_id', // свой id, чтобы можно было добавить дочерние ссылки
		'title'  => 'Дочерняя ссылка',
		'href'   => 'http://example.com/subpage',
	) );
}

В результате получим:

toolbar4

Чтобы изменить положение всего блока ссылок, пункта (поставить его до или после какого-то блока), измените число 30 — чем больше, тем ближе к концу.

0

#2 Дочерняя ссылка в меню сайта на страницу плагинов

// дочерняя ссылка в меню сайта на страницу плагинов
if( ! is_admin() ){

	add_action( 'admin_bar_menu', function ( $wp_admin_bar ) {

		$wp_admin_bar->add_menu( array(
			'parent' => 'site-name', // id родительского элемента
			'id'     => 'plugins_link', // свой id, чтобы можно было добавить дочерние ссылки
			'title'  => 'Плагины',
			'href'   => admin_url('plugins.php'),
		) );
	}, 100 );
}
0

#3 Как найти нужные идентификатор элемента меню

Чтобы настроить пункт меню, необходимо сначала найти правильный id (узел) ссылки.

Щелкните правой кнопкой мыши на ссылке меню в браузере и выберите Inspect Element - откроется инспектор, где можно увидеть html страницы.

Найдите тег id у выбранного элемента.

Например, если мне нужно настроить выпадающий список сайтов - я найду id: wp-admin-bar-site-name.

ID который нам нужен - это site-name, т.е. нужно удалить wp-admin-bar-.

Список ID (узлов)

На панели инструментов администратора имеются различные узлы верхнего уровня и подменю:

wp-logo
about
wporg
documentation
support-forum
feedback

site-name
dashboard
themes
customize
widgets
menus
customize-background
customize-header

comments

new-content
new-post
new-media
new-page
new-user

edit

user-actions (справа - рядом с изображением вашего аватара)
user-info
edit-profile
logout

При удалении узла верхнего уровня удаляется ссылка и подменю (если оно есть).

Примеры использования

Следующий код добавляет ссылку на медиатеку в выпадающее меню названия сайта.

add_action( 'admin_bar_menu', 'add_link_to_admin_bar',999 );

function add_link_to_admin_bar( $admin_bar ) {    

	$args = array(
		'parent' => 'site-name',
		'id'     => 'media-libray',
		'title'  => 'Media Library',
		'href'   => esc_url( admin_url( 'upload.php' ) ),
		'meta'   => false
	);

	$admin_bar->add_node( $args );       
}

Следующий код добавляет медиатеку и ссылку на плагины в выпадающее меню сайта.

add_action( 'admin_bar_menu', 'add_links_to_admin_bar',999 );

function add_links_to_admin_bar( $admin_bar ) {  

	$args = array(
		'parent' => 'site-name',
		'id'     => 'media-libray',
		'title'  => 'Media Library',
		'href'   => esc_url( admin_url( 'upload.php' ) ),
		'meta'   => false
	);

	$admin_bar->add_node( $args );

	$args = array(
		'parent' => 'site-name',
		'id'     => 'plugins',
		'title'  => 'Plugins',
		'href'   => esc_url( admin_url( 'plugins.php' ) ),
		'meta'   => false
	);

	$admin_bar->add_node( $args );
}

Следующий код добавляет ссылку верхнего уровня и ссылки подменю медиатеки и плагинов в выпадающий список Custom Made.

add_action( 'admin_bar_menu', 'add_top_link_to_admin_bar',999 );

function add_top_link_to_admin_bar( $admin_bar ) {

	// add a parent item
	$args = array(
		'id'    => 'custom',
		'title' => 'Custom Made',
		'href'   => 'http://example.com/', // Showing how to add an external link
	);

	$admin_bar->add_node( $args );

	// add a child item to our parent item  
	$args = array(
		'parent' => 'custom',
		'id'     => 'media-libray',
		'title'  => 'Media Library',
		'href'   => esc_url( admin_url( 'upload.php' ) ),
		'meta'   => false       
	);

	$admin_bar->add_node( $args );

	// add a child item to our parent item  
	$args = array(
		'parent' => 'custom',
		'id'     => 'plugins',
		'title'  => 'Plugins',
		'href'   => esc_url( admin_url( 'plugins.php' ) ),
		'meta'   => false       
	);

	$admin_bar->add_node( $args );                       
}
0

#4 Превращение существующего дочернего узла в родительский узел

В этом примере заменим существующий узел идентификатора этого узла. Следующий код сделает дочерний узел с ID "new-post" (New > Post) родительским узлом.

add_action( 'admin_bar_menu', 'make_parent_node', 999 );

/**
 * Modifies the "Add New Post" Toolbar item to move it to the top-level.
 *
 * @param WP_Admin_Bar $wp_admin_bar Toolbar instance.
 */
function make_parent_node( $wp_admin_bar ) {

	$args = array(
		'id'     => 'new-post',                         // id of the existing child node (New > Post)
		'title'  => __( 'Add New Post', 'textdomain' ), // alter the title of existing node
		'parent' => false,                              // set parent to false to make it a top level (parent) node
	);

	$wp_admin_bar->add_node( $args );
}

Список изменений

С версии 3.1.0 Введена.
С версии 4.5.0 Added the ability to pass 'lang' and 'dir' meta data.

Код WP_Admin_Bar::add_node() WP 6.1.1

public function add_node( $args ) {
	// Shim for old method signature: add_node( $parent_id, $menu_obj, $args ).
	if ( func_num_args() >= 3 && is_string( $args ) ) {
		$args = array_merge( array( 'parent' => $args ), func_get_arg( 2 ) );
	}

	if ( is_object( $args ) ) {
		$args = get_object_vars( $args );
	}

	// Ensure we have a valid title.
	if ( empty( $args['id'] ) ) {
		if ( empty( $args['title'] ) ) {
			return;
		}

		_doing_it_wrong( __METHOD__, __( 'The menu ID should not be empty.' ), '3.3.0' );
		// Deprecated: Generate an ID from the title.
		$args['id'] = esc_attr( sanitize_title( trim( $args['title'] ) ) );
	}

	$defaults = array(
		'id'     => false,
		'title'  => false,
		'parent' => false,
		'href'   => false,
		'group'  => false,
		'meta'   => array(),
	);

	// If the node already exists, keep any data that isn't provided.
	$maybe_defaults = $this->get_node( $args['id'] );
	if ( $maybe_defaults ) {
		$defaults = get_object_vars( $maybe_defaults );
	}

	// Do the same for 'meta' items.
	if ( ! empty( $defaults['meta'] ) && ! empty( $args['meta'] ) ) {
		$args['meta'] = wp_parse_args( $args['meta'], $defaults['meta'] );
	}

	$args = wp_parse_args( $args, $defaults );

	$back_compat_parents = array(
		'my-account-with-avatar' => array( 'my-account', '3.3' ),
		'my-blogs'               => array( 'my-sites', '3.3' ),
	);

	if ( isset( $back_compat_parents[ $args['parent'] ] ) ) {
		list( $new_parent, $version ) = $back_compat_parents[ $args['parent'] ];
		_deprecated_argument( __METHOD__, $version, sprintf( 'Use <code>%s</code> as the parent for the <code>%s</code> admin bar node instead of <code>%s</code>.', $new_parent, $args['id'], $args['parent'] ) );
		$args['parent'] = $new_parent;
	}

	$this->_set_node( $args );
}