Changeset 38574

Timestamp:

09/08/2016 05:30:32 AM (8 years ago)

Author:

peterwilsoncc

Message:

Menus: Improve documentation of new $item_spacing argument.

Adds @since tags for and improves description of the new $item_spacing argument added to wp_nav_menu(), wp_list_pages(), and wp_page_menu() in [38523].

Props johnbillion for copy.
See #35206.

Location:

trunk/src/wp-includes

Files:

• nav-menu-template.php (modified) (2 diffs)
• post-template.php (modified) (4 diffs)

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

@@ -15 +15 @@
  *
  * @since 3.0.0
+ * @since 4.7.0 Added the `item_spacing` argument.
  *
  * @staticvar array $menu_id_slugs
@@ -41 +42 @@
  *     @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 whitespace format the menu's HTML: 'discard' or 'preserve' (default).
+ *     @type string             $item_spacing    Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'.
  * }
  * @return object|false|void Menu output if $echo is false, false if there are no items or no menu was found.

trunk/src/wp-includes/post-template.php

@@ -1110 +1110 @@
  *
  * @since 1.5.0
+ * @since 4.7.0 Added the `item_spacing` argument.
  *
  * @see get_pages()
@@ -1139 +1140 @@
  *     @type string $title_li     List heading. Passing a null or empty value will result in no heading, and the list
  *                                will not be wrapped with unordered list `<ul>` tags. Default 'Pages'.
- *     @type string $item_spacing Whether whitespace format the menu's HTML: 'discard' or 'preserve' (default).
+ *     @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'.
  *     @type Walker $walker       Walker instance to use for listing pages. Default empty (Walker_Page).
  * }
@@ -1233 +1234 @@
  * @since 2.7.0
  * @since 4.4.0 Added `menu_id`, `container`, `before`, `after`, and `walker` arguments.
+ * @since 4.7.0 Added the `item_spacing` argument.
  *
  * @param array|string $args {
@@ -1250 +1252 @@
  *     @type string          $before       The HTML or text to prepend to the menu. Default is '<ul>'.
  *     @type string          $after        The HTML or text to append to the menu. Default is '</ul>'.
- *     @type string          $item_spacing Whether whitespace format the menu's HTML: 'discard' or 'preserve' (default).
+ *     @type string          $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'discard'.
  *     @type Walker          $walker       Walker instance to use for listing pages. Default empty (Walker_Page).
  * }