Changeset 46102

Timestamp:

09/13/2019 05:57:57 PM (5 years ago)

Author:

desrosj

Message:

Menus: Nav menu locations should not be integers.

When nav menu location slugs are integers, some hard to debug results can occur. register_nav_menus() utilizes array_merge() which renumbers numeric indexes, starting from 0. Because of this, numeric menu locations will almost always be changed.

This change introduces a _doing_it_wrong() notice to inform developers that nav menu locations should always be strings.

Props audrasjb, desrosj, welcher.
Fixes #45361.

Location:

trunk

Files:

• src/wp-includes/nav-menu.php (modified) (1 diff)
• tests/phpunit/tests/menu/nav-menu.php (modified) (2 diffs)

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

@@ -92 +92 @@
 
     add_theme_support( 'menus' );
+
+    foreach ( $locations as $key => $value ) {
+        if ( is_int( $key ) ) {
+            _doing_it_wrong( __FUNCTION__, __( 'Nav menu locations must be strings.' ), '5.3' );
+            break;
+        }
+    }
 
     $_wp_registered_nav_menus = array_merge( (array) $_wp_registered_nav_menus, $locations );

trunk/tests/phpunit/tests/menu/nav-menu.php

@@ -183 +183 @@
      * Technically possible to register menu locations numerically.
      *
+     * @expectedIncorrectUsage register_nav_menus
+     *
      * @covers ::wp_map_nav_menu_locations()
      */
@@ -205 +207 @@
     /**
      * Technically possible old nav menu locations were registered numerically.
+     *
+     * @expectedIncorrectUsage register_nav_menus
      *
      * @covers wp_map_nav_menu_locations()