<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[54999] trunk/src/wp-includes: Menus: Prevent infinite loop in menus.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/54999">54999</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/54999","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-12-16 02:38:10 +0000 (Fri, 16 Dec 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/56926">#56926</a>.
See <a href="https://core.trac.wordpress.org/ticket/28620">#28620</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunksrcwpincludesnavmenutemplatephp">trunk/src/wp-includes/nav-menu-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesdefaultfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2022-12-15 22:53:43 UTC (rev 54998)
+++ trunk/src/wp-includes/default-filters.php 2022-12-16 02:38:10 UTC (rev 54999)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -617,6 +617,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Nav menu.
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'nav_menu_item_id', '_nav_menu_item_id_use_once', 10, 2 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'nav_menu_css_class', 'wp_nav_menu_remove_menu_item_has_children_class', 10, 4 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Widgets.
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'after_setup_theme', 'wp_setup_widgets_block_editor', 1 );
</span></span></pre></div>
<a id="trunksrcwpincludesnavmenutemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/nav-menu-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/nav-menu-template.php 2022-12-15 22:53:43 UTC (rev 54998)
+++ trunk/src/wp-includes/nav-menu-template.php 2022-12-16 02:38:10 UTC (rev 54999)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -196,7 +196,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> _wp_menu_item_classes_by_context( $menu_items );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $sorted_menu_items = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $menu_items_tree = array();
</del><span class="cx" style="display: block; padding: 0 10px"> $menu_items_with_children = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $menu_items as $menu_item ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Fix invalid `menu_item_parent`. See: https://core.trac.wordpress.org/ticket/56926.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -205,34 +204,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $sorted_menu_items[ $menu_item->menu_order ] = $menu_item;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $menu_items_tree[ $menu_item->ID ] = $menu_item->menu_item_parent;
</del><span class="cx" style="display: block; padding: 0 10px"> if ( $menu_item->menu_item_parent ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $menu_items_with_children[ $menu_item->menu_item_parent ] = 1;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $menu_items_with_children[ $menu_item->menu_item_parent ] = true;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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 ];
- }
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Add the menu-item-has-children class where applicable.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $menu_items_with_children ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $sorted_menu_items as &$menu_item ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if (
- isset( $menu_items_with_children[ $menu_item->ID ] ) &&
- ( $args->depth <= 0 || $menu_items_with_children[ $menu_item->ID ] < $args->depth )
- ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $menu_items_with_children[ $menu_item->ID ] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $menu_item->classes[] = 'menu-item-has-children';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $menu_items_tree, $menu_items_with_children, $menu_items, $menu_item );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $menu_items, $menu_item );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the sorted list of menu item objects before generating the menu's HTML.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -648,3 +634,37 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $id;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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;
+}
</ins></span></pre>
</div>
</div>
</body>
</html>