WordPress.org

Make WordPress Core

Changeset 48364


Ignore:
Timestamp:
07/07/2020 09:26:16 AM (17 months ago)
Author:
SergeyBiryukov
Message:

Docs: Improve DocBlocks in wp-includes/nav-menu-template.php per the documentation standards.

See #49572.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/nav-menu-template.php

    r48349 r48364  
    2121 *     Optional. Array of nav menu arguments.
    2222 *
    23  *     @type int|string|WP_Term $menu                 Desired menu. Accepts a menu ID, slug, name, or object. Default empty.
    24  *     @type string             $menu_class           CSS class to use for the ul element which forms the menu. Default 'menu'.
     23 *     @type int|string|WP_Term $menu                 Desired menu. Accepts a menu ID, slug, name, or object.
     24 *                                                    Default empty.
     25 *     @type string             $menu_class           CSS class to use for the ul element which forms the menu.
     26 *                                                    Default 'menu'.
    2527 *     @type string             $menu_id              The ID that is applied to the ul element which forms the menu.
    2628 *                                                    Default is the menu slug, incremented.
    27  *     @type string             $container            Whether to wrap the ul, and what to wrap it with. Default 'div'.
    28  *     @type string             $container_class      Class that is applied to the container. Default 'menu-{menu slug}-container'.
     29 *     @type string             $container            Whether to wrap the ul, and what to wrap it with.
     30 *                                                    Default 'div'.
     31 *     @type string             $container_class      Class that is applied to the container.
     32 *                                                    Default 'menu-{menu slug}-container'.
    2933 *     @type string             $container_id         The ID that is applied to the container. Default empty.
    30  *     @type string             $container_aria_label The aria-label attribute that is applied to the container when it's a nav element. Default empty.
     34 *     @type string             $container_aria_label The aria-label attribute that is applied to the container
     35 *                                                    when it's a nav element. Default empty.
    3136 *     @type callable|bool      $fallback_cb          If the menu doesn't exist, a callback function will fire.
    3237 *                                                    Default is 'wp_page_menu'. Set to false for no fallback.
     
    3641 *     @type string             $link_after           Text after the link text. Default empty.
    3742 *     @type bool               $echo                 Whether to echo the menu or return it. Default true.
    38  *     @type int                $depth                How many levels of the hierarchy are to be included. 0 means all. Default 0.
     43 *     @type int                $depth                How many levels of the hierarchy are to be included.
     44 *                                                    0 means all. Default 0.
     45 *                                                    Default 0.
    3946 *     @type object             $walker               Instance of a custom walker class. Default empty.
    40  *     @type string             $theme_location       Theme location to be used. Must be registered with register_nav_menu()
    41  *                                                    in order to be selectable by the user.
    42  *     @type string             $items_wrap           How the list items should be wrapped. Default is a ul with an id and class.
    43  *                                                    Uses printf() format with numbered placeholders.
    44  *     @type string             $item_spacing         Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'.
     47 *     @type string             $theme_location       Theme location to be used. Must be registered with
     48 *                                                    register_nav_menu() in order to be selectable by the user.
     49 *     @type string             $items_wrap           How the list items should be wrapped. Uses printf() format with
     50 *                                                    numbered placeholders. Default is a ul with an id and class.
     51 *     @type string             $item_spacing         Whether to preserve whitespace within the menu's HTML.
     52 *                                                    Accepts 'preserve' or 'discard'. Default 'preserve'.
    4553 * }
    4654 * @return void|string|false Void if 'echo' argument is true, menu output if 'echo' is false.
Note: See TracChangeset for help on using the changeset viewer.