From cc6836dc553e54206d58571ff895e2226ed4ec8a Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Mon, 3 Mar 2014 06:10:22 +0000 Subject: [PATCH] Convert argument array documentation to the hash-notation style for `WP_Admin_Bar::add_node()` and `WP_Admin_Bar::add_group()`. Fixes #27258. git-svn-id: https://develop.svn.wordpress.org/trunk@27370 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-admin-bar.php | 30 ++++++++++++++++---------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/src/wp-includes/class-wp-admin-bar.php b/src/wp-includes/class-wp-admin-bar.php index 86b8a82d1c..050b0f1c0e 100644 --- a/src/wp-includes/class-wp-admin-bar.php +++ b/src/wp-includes/class-wp-admin-bar.php @@ -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;