Changeset 54999

Timestamp:

12/16/2022 02:38:10 AM (2 years ago)

Author:

peterwilsoncc

Message:

Menus: Prevent infinite loop in menus.

This modifies how the menu-item-has-children class is removed from bottom level menu items. Instead of removing the class within wp_nav_menu() a filter is applied to the nav_menu_css_class hook to remove the class as required.

Introduces wp_nav_menu_remove_menu_item_has_children_class() for removing the class.

Reverts source code changes in [54478,54801], the tests are retained.

Props davidbinda, SergeyBiryukov, mhkuu, JeffPaul, jmdodd, priethor, desrosj, hellofromTonya, azaozz, peterwilsoncc.
Fixes #56926.
See #28620.

Location:

trunk/src/wp-includes

Files:

• default-filters.php (modified) (1 diff)
• nav-menu-template.php (modified) (5 diffs)

trunk/src/wp-includes/default-filters.php

@@ -618 +618 @@
 // Nav menu.
 add_filter( 'nav_menu_item_id', '_nav_menu_item_id_use_once', 10, 2 );
+add_filter( 'nav_menu_css_class', 'wp_nav_menu_remove_menu_item_has_children_class', 10, 4 );
 
 // Widgets.

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

@@ -197 +197 @@
 
     $sorted_menu_items        = array();
-    $menu_items_tree          = array();
     $menu_items_with_children = array();
     foreach ( (array) $menu_items as $menu_item ) {
@@ -206 +205 @@
 
         $sorted_menu_items[ $menu_item->menu_order ] = $menu_item;
-        $menu_items_tree[ $menu_item->ID ]           = $menu_item->menu_item_parent;
         if ( $menu_item->menu_item_parent ) {
-            $menu_items_with_children[ $menu_item->menu_item_parent ] = 1;
-        }
-    }
-
-    // Calculate the depth of each menu item with children.
-    foreach ( $menu_items_with_children as $menu_item_key => &$menu_item_depth ) {
-        $menu_item_parent = $menu_items_tree[ $menu_item_key ];
-        while ( $menu_item_parent ) {
-            $menu_item_depth  = $menu_item_depth + 1;
-            $menu_item_parent = $menu_items_tree[ $menu_item_parent ];
+            $menu_items_with_children[ $menu_item->menu_item_parent ] = true;
         }
     }
@@ -224 +213 @@
     if ( $menu_items_with_children ) {
         foreach ( $sorted_menu_items as &$menu_item ) {
-            if (
-                isset( $menu_items_with_children[ $menu_item->ID ] ) &&
-                ( $args->depth <= 0 || $menu_items_with_children[ $menu_item->ID ] < $args->depth )
-            ) {
+            if ( isset( $menu_items_with_children[ $menu_item->ID ] ) ) {
                 $menu_item->classes[] = 'menu-item-has-children';
             }
@@ -233 +219 @@
     }
 
-    unset( $menu_items_tree, $menu_items_with_children, $menu_items, $menu_item );
+    unset( $menu_items, $menu_item );
 
     /**
@@ -649 +635 @@
     return $id;
 }
+
+/**
+ * Remove the `menu-item-has-children` class from bottom level menu items.
+ *
+ * @since 6.1.2
+ *
+ * @param string[] $classes   Array of the CSS classes that are applied to the menu item's `<li>` element.
+ * @param WP_Post  $menu_item The current menu item object.
+ * @param stdClass $args      An object of wp_nav_menu() arguments.
+ * @param int      $depth     Depth of menu item.
+ * @return string[] Modified nav menu classes.
+ */
+function wp_nav_menu_remove_menu_item_has_children_class( $classes, $menu_item, $args, $depth ) {
+    // Max-depth is 1-based.
+    $max_depth = isset( $args->depth ) ? (int) $args->depth : 0;
+    // Depth is 0-based so needs to be increased by one.
+    $depth = $depth + 1;
+
+    // Complete menu tree is displayed.
+    if ( 0 === $max_depth ) {
+        return $classes;
+    }
+
+    /*
+     * Remove the `menu-item-has-children` class from bottom level menu items.
+     * -1 is used to display all menu items in one level so the class should
+     * be removed from all menu items.
+     */
+    if ( -1 === $max_depth || $depth >= $max_depth ) {
+        $classes = array_diff( $classes, array( 'menu-item-has-children' ) );
+    }
+
+    return $classes;
+}