Changeset 38523 for trunk/src/wp-includes/nav-menu-template.php

Timestamp:

09/06/2016 09:05:45 AM (8 years ago)

Author:

peterwilsoncc

Message:

Menus: Add white space option to wp_nav_menu() and wp_list_pages().

Adds an item_spacing option to the arguments array for the functions wp_nav_menu(), wp_list_pages(), and wp_page_menu(). item_spacing is a boolean accepting either preserve or discard.

Previously, certain CSS choices could result in a site's layout changing if wp_nav_menu() fell back to the default wp_list_pages() due to differences in the whitespace within the HTML. The new argument ensures a function outputs consistant HTML while maintaining backward compatibility.

Fixes #35206.

File:

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

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

@@ -41 +41 @@
  *     @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).
  * }
  * @return object|false|void Menu output if $echo is false, false if there are no items or no menu was found.
@@ -48 +49 @@
 
     $defaults = array( 'menu' => '', 'container' => 'div', 'container_class' => '', 'container_id' => '', 'menu_class' => 'menu', 'menu_id' => '',
-    'echo' => true, 'fallback_cb' => 'wp_page_menu', 'before' => '', 'after' => '', 'link_before' => '', 'link_after' => '', 'items_wrap' => '<ul id="%1$s" class="%2$s">%3$s</ul>',
+    'echo' => true, 'fallback_cb' => 'wp_page_menu', 'before' => '', 'after' => '', 'link_before' => '', 'link_after' => '', 'items_wrap' => '<ul id="%1$s" class="%2$s">%3$s</ul>', 'item_spacing' => 'preserve',
     'depth' => 0, 'walker' => '', 'theme_location' => '' );
 
     $args = wp_parse_args( $args, $defaults );
+
+    if ( ! in_array( $args['item_spacing'], array( 'preserve', 'discard' ), true ) ) {
+        // invalid value, fall back to default.
+        $args['item_spacing'] = $defaults['item_spacing'];
+    }
+
     /**
      * Filters the arguments used to display a navigation menu.