walk_nav_menu_tree( array $items, int $depth, stdClass $args ): string
- Since
- 3.0.0
- Source
wp-includes/nav-menu-template.php:618
Compatibility
- WordPress
- since 3.0.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
$itemsarray- The menu items, sorted by each menu item's menu order.
$depthint- Depth of the item in reference to parents.
$argsstdClass- An object containing wp_nav_menu() arguments.
Return value
string- The HTML list content for the menu items.
Performance profile
How much work a call to walk_nav_menu_tree() 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
- 13–16
- Plugin surface
- None
- Called by
- 6
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 17.
Nothing here hands control to plugin code.
6 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost walk_nav_menu_tree() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 13–16 | ->walk() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 17 | 13–16 | 1 | |
| 8.5 | 17 | 13–16 | 1 | |
| 8.4 | 17 | 13–16 | 1 | |
| 8.3 | 17 | 13–16 | 1 | |
| 8.2 | 17 | 13–16 | 1 | |
| 8.1 | 17 | 13–16 | 1 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 18 | 14–16 | 1 |
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.
Uses · 1
- Walker_Nav_Menu::__construct()Constructor.
Used by · 6
- _wp_ajax_menu_quick_search()Prints the appropriate response to a menu quick search.
- wp_ajax_add_menu_item()Handles adding a menu item via AJAX.
- wp_get_nav_menu_to_edit()Returns the menu formatted to edit.
- wp_nav_menu()Displays a navigation menu.
- wp_nav_menu_item_post_type_meta_box()Displays a meta box for a post type menu item.
- wp_nav_menu_item_taxonomy_meta_box()Displays a meta box for a taxonomy menu item.
Source code
function walk_nav_menu_tree( $items, $depth, $args ) { $walker = ( empty( $args->walker ) ) ? new Walker_Nav_Menu() : $args->walker; return $walker->walk( $items, $depth, $args );}Changelog
Introduced in 3.0.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.0.4 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.