WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Admin_Bar::add_group()

WP_Admin_Bar::add_group( array $args )

In this article

Back to top

Adds a group to a toolbar menu node.

Description

Groups can be used to organize toolbar items into distinct sections of a toolbar menu.

Parameters

$argsarrayrequired
Array of arguments for adding a group.
  • id string
    ID of the item.
  • parent string
    Optional. ID of the parent node. Default 'root'.
  • meta array
    Meta data for the group including the following keys: 'class', 'onclick', 'target', and 'title'.

More Information

  • Toolbar items are also called “nodes”. Nodes can be parents for other nodes, which creates dropdown menus. When adding a group you’re actually adding a group node. Group nodes are not visible in the Toolbar, but nodes added to it are.
  • This function is a method of the WP_Admin_Bar class and $wp_admin_bar global object, which may not exist except during the ‘admin_bar_menu‘ or ‘wp_before_admin_bar_render‘ hooks.
  • The Toolbar replaces the Admin Bar since WordPress Version 3.3.

Source

final public function add_group( $args ) {
	$args['group'] = true;

	$this->add_node( $args );
}

View all references View on Trac View on GitHub

UsesDescription
WP_Admin_Bar::add_node()wp-includes/class-wp-admin-bar.php

Adds a node to the menu.

Used byDescription
wp_admin_bar_my_account_menu()wp-includes/admin-bar.php

Adds the “My Account” submenu items.

wp_admin_bar_my_sites_menu()wp-includes/admin-bar.php

Adds the “My Sites/[Site Name]” menu and all submenus.

wp_admin_bar_appearance_menu()wp-includes/admin-bar.php

Adds appearance submenu items to the “Site Name” menu.

wp_admin_bar_add_secondary_groups()wp-includes/admin-bar.php

Adds secondary menus.

Changelog

VersionDescription
3.3.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Codex
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    Adding a group to a parent node

    This example adds a parent node, child nodes and a group to the toolbar.

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

function add_nodes_and_groups_to_toolbar( $wp_admin_bar ) {

	// add a parent item
	$args = array(
		'id'    => 'parent_node',
		'title' => 'parent node'
	);
	$wp_admin_bar->add_node( $args );

	// add a child item to our parent item
	$args = array(
		'id'     => 'child_node',
		'title'  => 'child node',
		'parent' => 'parent_node'
	);
	$wp_admin_bar->add_node( $args );

	// add a group node with a class "first-toolbar-group"
	$args = array(
		'id'     => 'first_group',
		'parent' => 'parent_node',
		'meta'   => array( 'class' => 'first-toolbar-group' )
	);
	$wp_admin_bar->add_group( $args );

	// add an item to our group item
	$args = array(
		'id'     => 'first_grouped_node',
		'title'  => 'first group node',
		'parent' => 'first_group'
	);
	$wp_admin_bar->add_node( $args );

	// add another child item to our parent item (not to our first group)
	$args = array(
		'id'     => 'another_child_node',
		'title'  => 'another child node',
		'parent' => 'parent_node'
	);
	$wp_admin_bar->add_node( $args );

}

    The output from this example in the toolbar will be:

     * parent node
 ** child node
 ** another child node
 ** first group node

You must log in before being able to contribute a note or feedback.