Changeset 48364

Timestamp:

07/07/2020 09:26:16 AM (5 years ago)

Author:

SergeyBiryukov

Message:

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

See #49572.

File:

• trunk/src/wp-includes/nav-menu-template.php (modified) (2 diffs)

trunk/src/wp-includes/nav-menu-template.php

@@ -21 +21 @@
  *     Optional. Array of nav menu arguments.
  *
- *     @type int|string|WP_Term $menu                 Desired menu. Accepts a menu ID, slug, name, or object. Default empty.
- *     @type string             $menu_class           CSS class to use for the ul element which forms the menu. Default 'menu'.
+ *     @type int|string|WP_Term $menu                 Desired menu. Accepts a menu ID, slug, name, or object.
+ *                                                    Default empty.
+ *     @type string             $menu_class           CSS class to use for the ul element which forms the menu.
+ *                                                    Default 'menu'.
  *     @type string             $menu_id              The ID that is applied to the ul element which forms the menu.
  *                                                    Default is the menu slug, incremented.
- *     @type string             $container            Whether to wrap the ul, and what to wrap it with. Default 'div'.
- *     @type string             $container_class      Class that is applied to the container. Default 'menu-{menu slug}-container'.
+ *     @type string             $container            Whether to wrap the ul, and what to wrap it with.
+ *                                                    Default 'div'.
+ *     @type string             $container_class      Class that is applied to the container.
+ *                                                    Default 'menu-{menu slug}-container'.
  *     @type string             $container_id         The ID that is applied to the container. Default empty.
- *     @type string             $container_aria_label The aria-label attribute that is applied to the container when it's a nav element. Default empty.
+ *     @type string             $container_aria_label The aria-label attribute that is applied to the container
+ *                                                    when it's a nav element. Default empty.
  *     @type callable|bool      $fallback_cb          If the menu doesn't exist, a callback function will fire.
  *                                                    Default is 'wp_page_menu'. Set to false for no fallback.
@@ -36 +41 @@
  *     @type string             $link_after           Text after the link text. Default empty.
  *     @type bool               $echo                 Whether to echo the menu or return it. Default true.
- *     @type int                $depth                How many levels of the hierarchy are to be included. 0 means all. Default 0.
+ *     @type int                $depth                How many levels of the hierarchy are to be included.
+ *                                                    0 means all. Default 0.
+ *                                                    Default 0.
  *     @type object             $walker               Instance of a custom walker class. Default empty.
- *     @type string             $theme_location       Theme location to be used. Must be registered with register_nav_menu()
- *                                                    in order to be selectable by the user.
- *     @type string             $items_wrap           How the list items should be wrapped. Default is a ul with an id and class.
- *                                                    Uses printf() format with numbered placeholders.
- *     @type string             $item_spacing         Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'.
+ *     @type string             $theme_location       Theme location to be used. Must be registered with
+ *                                                    register_nav_menu() in order to be selectable by the user.
+ *     @type string             $items_wrap           How the list items should be wrapped. Uses printf() format with
+ *                                                    numbered placeholders. Default is a ul with an id and class.
+ *     @type string             $item_spacing         Whether to preserve whitespace within the menu's HTML.
+ *                                                    Accepts 'preserve' or 'discard'. Default 'preserve'.
  * }
  * @return void|string|false Void if 'echo' argument is true, menu output if 'echo' is false.