Skip to content

Menus: Fix nav_menu_item_args filter side effects between menu items #9346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SainathPoojary wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Menus: Fix nav_menu_item_args filter side effects between menu items #9346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
628417e
Menus: Fix `nav_menu_item_args` filter side effects between menu items
SainathPoojary Jul 29, 2025
cae145a
Menus: Add tests to prevent nav_menu_item_args filter leakage between…
SainathPoojary Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/wp-includes/class-walker-nav-menu.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,8 @@ public function start_el( &$output, $data_object, $depth = 0, $args = null, $cur
// Restores the more descriptive, specific name for use within this method.
$menu_item = $data_object;

if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) {
$args = (array) $args;
if ( isset( $args['item_spacing'] ) && 'discard' === $args['item_spacing'] ) {
$t = '';
$n = '';
} else {
Expand All @@ -178,7 +179,7 @@ public function start_el( &$output, $data_object, $depth = 0, $args = null, $cur
* @param WP_Post $menu_item Menu item data object.
* @param int $depth Depth of menu item. Used for padding.
*/
$args = apply_filters( 'nav_menu_item_args', $args, $menu_item, $depth );
$args = apply_filters( 'nav_menu_item_args', (object) $args, $menu_item, $depth );

/**
* Filters the CSS classes applied to a menu item's list item element.
Expand Down
68 changes: 68 additions & 0 deletions tests/phpunit/tests/menu/walker-nav-menu.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,4 +435,72 @@ public function data_build_atts_should_build_attributes() {
),
);
}

/**
* Tests that modifications to `$args` in the `nav_menu_item_args` filter do not leak between menu items.
*
* @ticket 37344
*
* @covers Walker_Nav_Menu::start_el
*/
public function test_walker_nav_menu_start_el_should_not_leak_nav_menu_item_args_filter_changes_between_items() {
add_filter( 'nav_menu_item_args', array( $this, 'filter_nav_menu_item_args_append_marker' ), 10, 3 );

$item1 = array(
'ID' => 1,
'title' => 'Item 1',
'classes' => array(),
'current' => false,
'target' => '',
'xfn' => '',
'url' => 'http://example.com/item1',
);

$item2 = array(
'ID' => 2,
'title' => 'Item 2',
'classes' => array(),
'current' => false,
'target' => '',
'xfn' => '',
'url' => 'http://example.com/item2',
);

$args = array(
'before' => '',
'after' => '',
'link_before' => '',
'link_after' => '',
);

$output1 = '';
$this->walker->start_el( $output1, (object) $item1, 0, (object) $args );

$output2 = '';
$this->walker->start_el( $output2, (object) $item2, 0, (object) $args );

remove_filter( 'nav_menu_item_args', array( $this, 'filter_nav_menu_item_args_append_marker' ), 10 );

// Both menu items should have exactly one 'X' marker, not accumulating.
$this->assertStringContainsString( '>X<a href="http://example.com/item1">Item 1</a>', $output1 );
$this->assertStringContainsString( '>X<a href="http://example.com/item2">Item 2</a>', $output2 );

// Ensure no accumulation - Item 2 should not contain 'XX'.
$this->assertStringNotContainsString( '>XX<a href="http://example.com/item2">Item 2</a>', $output2 );
}

/**
* Filter callback for testing nav_menu_item_args filter side effects.
*
* Appends a marker character to the 'before' argument to test for accumulation.
*
* @param stdClass $args An object of wp_nav_menu() arguments.
* @param WP_Post $menu_item Menu item data object.
* @param int $depth Depth of menu item. Used for padding.
* @return stdClass Modified arguments object.
*/
public function filter_nav_menu_item_args_append_marker( $args, $menu_item, $depth ) {
$args->before .= 'X';
return $args;
}
}
Loading