Make WordPress Core

Changeset 27370


Ignore:
Timestamp:
03/03/2014 06:10:22 AM (10 years ago)
Author:
DrewAPicture
Message:

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

Fixes #27258.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-admin-bar.php

    r27367 r27370  
    8282     * Add a node to the menu.
    8383     *
    84      * @param array $args - The arguments for each node.
    85      * - id         - string    - The ID of the item.
    86      * - title      - string    - The title of the node.
    87      * - parent     - string    - The ID of the parent node. Optional.
    88      * - href       - string    - The link for the item. Optional.
    89      * - group      - boolean   - If the node is a group. Optional. Default false.
    90      * - meta       - array     - Meta data including the following keys: html, class, onclick, target, title, tabindex, rel.
     84     * @param array $args {
     85     *     Arguments for adding a node.
     86     *
     87     *     @type string $id     ID of the item.
     88     *     @type string $title  Title of the node.
     89     *     @type string $parent Optional. ID of the parent node.
     90     *     @type string $href   Optional. Link for the item.
     91     *     @type bool   $group  Optional. Whether or not the node is a group. Default false.
     92     *     @type array  $meta   Meta data including the following keys: 'html', 'class', 'rel',
     93     *                          'onclick', 'target', 'title', 'tabindex'. Default empty.
     94     * }
    9195     */
    9296    public function add_node( $args ) {
     
    188192     * @since 3.3.0
    189193     *
    190      * @param array $args - The arguments for each node.
    191      * - id         - string    - The ID of the item.
    192      * - parent     - string    - The ID of the parent node. Optional. Default root.
    193      * - meta       - array     - Meta data including the following keys: class, onclick, target, title.
     194     * @param array $args {
     195     *     Array of arguments for adding a group.
     196     *
     197     *     @type string $id     ID of the item.
     198     *     @type string $parent Optional. ID of the parent node. Default 'root'.
     199     *     @type array  $meta   Meta data for the group including the following keys:
     200     *                         'class', 'onclick', 'target', and 'title'.
     201     * }
    194202     */
    195203    final public function add_group( $args ) {
Note: See TracChangeset for help on using the changeset viewer.