<!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>[55005] trunk: Menus: Account for legacy calls to `nav_menu_css_class` filter.</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/55005">55005</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/55005","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-18 23:59:51 +0000 (Sun, 18 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: Account for legacy calls to `nav_menu_css_class` filter.
Modify `wp_nav_menu_remove_menu_item_has_children_class()` to account for changes to the `nav_menu_css_class` filter since it's introduction.
The `$args` and `$depth` parameters were added after the filter's introduction so this protects against fatal errors in custom walkers applying the filter in a legacy format.
Without the `$args` or `$depth` parameters, `wp_nav_menu_remove_menu_item_has_children_class()` no longer attempts to remove the `menu-item-has-children` from the lowest level menu items as these are required to determine the current branch the walker is walking.
Follow up to <a href="https://core.trac.wordpress.org/changeset/54999">[54999]</a>.
Props dd32, azaozz, peterwilsoncc.
See <a href="https://core.trac.wordpress.org/ticket/56926">#56926</a>, <a href="https://core.trac.wordpress.org/ticket/28620">#28620</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesnavmenutemplatephp">trunk/src/wp-includes/nav-menu-template.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsmenuwpNavMenuRemoveMenuItemHasChildrenClassphp">trunk/tests/phpunit/tests/menu/wpNavMenuRemoveMenuItemHasChildrenClass.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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-18 13:00:29 UTC (rev 55004)
+++ trunk/src/wp-includes/nav-menu-template.php 2022-12-18 23:59:51 UTC (rev 55005)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -638,15 +638,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Remove the `menu-item-has-children` class from bottom level menu items.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This runs on the {@see 'nav_menu_css_class'} filter. The $args and $depth
+ * parameters were added after the filter was originally introduced in
+ * WordPress 3.0.0 so this needs to allow for cases in which the filter is
+ * called without them.
+ *
+ * @see https://core.trac.wordpress.org/ticket/56926.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.2
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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|false $args An object of wp_nav_menu() arguments. Default false ($args unspecified when filter is called).
+ * @param int|false $depth Depth of menu item. Default false ($depth unspecified when filter is called).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string[] Modified nav menu classes.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_nav_menu_remove_menu_item_has_children_class( $classes, $menu_item, $args, $depth ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_nav_menu_remove_menu_item_has_children_class( $classes, $menu_item, $args = false, $depth = false ) {
+ /*
+ * Account for the filter being called without the $args or $depth parameters.
+ *
+ * This occurs when a theme uses a custom walker calling the `nav_menu_css_class`
+ * filter using the legacy formats prior to the introduction of the $args and
+ * $depth parameters.
+ *
+ * As both of these parameters are required for this function to determine
+ * both the current and maximum depth of the menu tree, the function does not
+ * attempt to remove the `menu-item-has-children` class if these parameters
+ * are not set.
+ */
+ if ( false === $depth || false === $args ) {
+ return $classes;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Max-depth is 1-based.
</span><span class="cx" style="display: block; padding: 0 10px"> $max_depth = isset( $args->depth ) ? (int) $args->depth : 0;
</span><span class="cx" style="display: block; padding: 0 10px"> // Depth is 0-based so needs to be increased by one.
</span></span></pre></div>
<a id="trunktestsphpunittestsmenuwpNavMenuRemoveMenuItemHasChildrenClassphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/menu/wpNavMenuRemoveMenuItemHasChildrenClass.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/menu/wpNavMenuRemoveMenuItemHasChildrenClass.php (rev 0)
+++ trunk/tests/phpunit/tests/menu/wpNavMenuRemoveMenuItemHasChildrenClass.php 2022-12-18 23:59:51 UTC (rev 55005)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,100 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group menu
+ */
+class Tests_Menu_WpNavMenuRemoveMenuItemHasChildrenClass extends WP_UnitTestCase {
+
+ /**
+ * Ensure calling filter in legacy ways does not throw an error.
+ *
+ * @ticket 56926
+ */
+ public function test_legacy_filter_should_not_throw_an_error() {
+ $classes = array( 'menu-item-has-children', 'menu-item', 'menu-item-123' );
+
+ $menu_item = (object) array(
+ 'classes' => $classes,
+ );
+
+ $args = (object) array(
+ 'depth' => 2,
+ );
+
+ $depth = 2;
+
+ $class_names = implode( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $menu_item ) );
+ $this->assertStringContainsString( 'menu-item-has-children', $class_names, 'Class name should be retained when filter is called with two arguments.' );
+ $class_names = implode( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $menu_item, $args ) );
+ $this->assertStringContainsString( 'menu-item-has-children', $class_names, 'Class name should be retained when filter is called with three arguments.' );
+ $class_names = implode( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $menu_item, $args, $depth ) );
+ $this->assertStringNotContainsString( 'menu-item-has-children', $class_names, 'Class name should not be retained when filter is called with four arguments.' );
+ }
+
+ /**
+ * Ensure menu-item-has-children class is removed or retained as expected.
+ *
+ * @dataProvider data_menu_item_has_children_class_should_be_removed_or_retained_as_expected
+ * @ticket 56926
+ */
+ public function test_menu_item_has_children_class_should_be_removed_or_retained_as_expected( $args, $depth, $should_be_retained ) {
+ $classes = array( 'menu-item-has-children', 'menu-item', 'menu-item-123' );
+
+ $menu_item = (object) array(
+ 'classes' => $classes,
+ );
+
+ $class_names = wp_nav_menu_remove_menu_item_has_children_class( $classes, $menu_item, $args, $depth );
+ if ( $should_be_retained ) {
+ $this->assertContains( 'menu-item-has-children', $class_names, 'Class name should be retained.' );
+ return;
+ }
+
+ $this->assertNotContains( 'menu-item-has-children', $class_names, 'Class name should not be retained.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_menu_item_has_children_class_should_be_removed_or_retained_as_expected() {
+ return array(
+ 'Depth not set' => array(
+ 'args' => (object) array( 'depth' => 1 ),
+ 'depth' => false,
+ 'should_be_retained' => true,
+ ),
+ 'Neither depth nor args set' => array(
+ 'args' => false,
+ 'depth' => false,
+ 'should_be_retained' => true,
+ ),
+ 'Max depth is set to minus 1' => array(
+ 'args' => (object) array( 'depth' => -1 ),
+ 'depth' => 1,
+ 'should_be_retained' => false,
+ ),
+ 'Max depth is set to zero' => array(
+ 'args' => (object) array( 'depth' => 0 ),
+ 'depth' => 1,
+ 'should_be_retained' => true,
+ ),
+ 'Item depth exceeds max depth' => array(
+ 'args' => (object) array( 'depth' => 2 ),
+ 'depth' => 3,
+ 'should_be_retained' => false,
+ ),
+ 'Item depth is lower than max depth' => array(
+ 'args' => (object) array( 'depth' => 5 ),
+ 'depth' => 3,
+ 'should_be_retained' => true,
+ ),
+ 'Item depth is one lower than max depth' => array(
+ 'args' => (object) array( 'depth' => 2 ),
+ 'depth' => 1,
+ 'should_be_retained' => false, // Depth is zero-based, max depth is not.
+ ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/menu/wpNavMenuRemoveMenuItemHasChildrenClass.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>