WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Convert argument array documentation to the hash-notation style for `WP_Admin_Bar::add_node()` and `WP_Admin_Bar::add_group()`. 

Fixes #27258.

Built from https://develop.svn.wordpress.org/trunk@27370


git-svn-id: http://core.svn.wordpress.org/trunk@27220 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-03-03 06:11:13 +00:00
parent 0c16c0477b
commit d2014cfce3
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
wp-includes/class-wp-admin-bar.php
View File

@ -81,13 +81,17 @@ class WP_Admin_Bar {
/**
* Add a node to the menu.
*
* @param array $args - The arguments for each node.
* - id - string - The ID of the item.
* - title - string - The title of the node.
* - parent - string - The ID of the parent node. Optional.
* - href - string - The link for the item. Optional.
* - group - boolean - If the node is a group. Optional. Default false.
* - meta - array - Meta data including the following keys: html, class, onclick, target, title, tabindex, rel.
* @param array $args {
* Arguments for adding a node.
*
* @type string $id ID of the item.
* @type string $title Title of the node.
* @type string $parent Optional. ID of the parent node.
* @type string $href Optional. Link for the item.
* @type bool $group Optional. Whether or not the node is a group. Default false.
* @type array $meta Meta data including the following keys: 'html', 'class', 'rel',
* 'onclick', 'target', 'title', 'tabindex'. Default empty.
* }
*/
public function add_node( $args ) {
// Shim for old method signature: add_node( $parent_id, $menu_obj, $args )
@ -187,10 +191,14 @@ class WP_Admin_Bar {
*
* @since 3.3.0
*
* @param array $args - The arguments for each node.
* - id - string - The ID of the item.
* - parent - string - The ID of the parent node. Optional. Default root.
* - meta - array - Meta data including the following keys: class, onclick, target, title.
* @param array $args {
* Array of arguments for adding a group.
*
* @type string $id ID of the item.
* @type string $parent Optional. ID of the parent node. Default 'root'.
* @type array $meta Meta data for the group including the following keys:
* 'class', 'onclick', 'target', and 'title'.
* }
*/
final public function add_group( $args ) {
$args['group'] = true;