wp_nav_menu_remove_menu_item_has_children_class( string[] $classes, WP_Post $menu_item, stdClass|false $args = false, int|false $depth = false ): string[]
- Since
- 6.2.0
- Source
wp-includes/nav-menu-template.php:664
menu-item-has-children class from bottom level menu items.Description
This runs on the '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.
Compatibility
- WordPress
- since 6.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$classesstring[]- Array of the CSS classes that are applied to the menu item's
<li>element. $argsstdClass|falseoptional- An object of wp_nav_menu() arguments. Default false ($args unspecified when filter is called).Default:
false $depthint|falseoptional- Depth of menu item. Default false ($depth unspecified when filter is called).Default:
false
Return value
string[]- Modified nav menu classes.
Performance profile
How much work a call to wp_nav_menu_remove_menu_item_has_children_class() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 7–28
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 31.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_nav_menu_remove_menu_item_has_children_class() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7–23 | none |
$depth !== false && $args !== false && $max_depth !== 0 | 24–28 | array_diff() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 31 instructions, 7–28 executed per call, 6 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Source code
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; } // 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;}Changelog
Introduced in 6.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/nav-menu-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.