[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> class-wp-admin-bar.php (summary)

Toolbar API: WP_Admin_Bar class

File Size: 665 lines (17 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_Admin_Bar:: (21 methods):
  __get()
  initialize()
  add_menu()
  remove_menu()
  add_node()
  _set_node()
  get_node()
  _get_node()
  get_nodes()
  _get_nodes()
  add_group()
  remove_node()
  _unset_node()
  render()
  _bind()
  _render()
  _render_container()
  _render_group()
  _render_item()
  recursive_render()
  add_menus()


Class: WP_Admin_Bar  - X-Ref

Core class used to implement the Toolbar API.

__get( $name )   X-Ref

return: string|array|void
param: string $name
since: 3.3.0

initialize()   X-Ref
Initializes the admin bar.

since: 3.1.0

add_menu( $node )   X-Ref
Adds a node (menu item) to the admin bar menu.

param: array $node The attributes that define the node.
since: 3.3.0

remove_menu( $id )   X-Ref
Removes a node from the admin bar.

param: string $id The menu slug to remove.
since: 3.1.0

add_node( $args )   X-Ref
Adds a node to the menu.

param: array $args {
since: 3.1.0
since: 4.5.0 Added the ability to pass 'lang' and 'dir' meta data.

_set_node( $args )   X-Ref

param: array $args
since: 3.3.0

get_node( $id )   X-Ref
Gets a node.

return: object|void Node.
param: string $id
since: 3.3.0

_get_node( $id )   X-Ref

return: object|void
param: string $id
since: 3.3.0

get_nodes()   X-Ref

return: array|void
since: 3.3.0

_get_nodes()   X-Ref

return: array|void
since: 3.3.0

add_group( $args )   X-Ref
Adds a group to a toolbar menu node.

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

param: array $args {
since: 3.3.0

remove_node( $id )   X-Ref
Remove a node.

param: string $id The ID of the item.
since: 3.1.0

_unset_node( $id )   X-Ref

param: string $id
since: 3.3.0

render()   X-Ref

since: 3.1.0

_bind()   X-Ref

return: object|void
since: 3.3.0

_render( $root )   X-Ref

param: object $root
since: 3.3.0

_render_container( $node )   X-Ref

param: object $node
since: 3.3.0

_render_group( $node )   X-Ref

param: object $node
since: 3.3.0

_render_item( $node )   X-Ref

param: object $node
since: 3.3.0

recursive_render( $id, $node )   X-Ref
Renders toolbar items recursively.

param: string $id    Unused.
param: object $node
since: 3.1.0

add_menus()   X-Ref
Adds menus to the admin bar.

since: 3.1.0



Generated: Sat Apr 27 01:00:02 2024 Cross-referenced by PHPXref 0.7.1