On this page
walk_nav_menu_tree( array $items, int $depth, stdClass $args ): string
Retrieves the HTML list content for nav menu items.
Parameters
$itemsarray Required-
The menu items, sorted by each menu item's menu order.
$depthint Required-
Depth of the item in reference to parents.
$argsstdClass Required-
An object containing wp_nav_menu() arguments.
More Arguments from wp_nav_menu( ... $args )
Array of nav menu arguments.
menuint|string|WP_TermDesired menu. Accepts a menu ID, slug, name, or object.
menu_classstringCSS class to use for the ul element which forms the menu.
Default'menu'.menu_idstringThe ID that is applied to the ul element which forms the menu.
Default is the menu slug, incremented.containerstringWhether to wrap the ul, and what to wrap it with.
Default'div'.container_classstringClass that is applied to the container.
Default 'menu-{menu slug}-container'.container_idstringThe ID that is applied to the container.container_aria_labelstringThe aria-label attribute that is applied to the container when it's a nav element.fallback_cbcallable|falseIf the menu doesn't exist, a callback function will fire.
Default is'wp_page_menu'. Set to false for no fallback.beforestringText before the link markup.afterstringText after the link markup.link_beforestringText before the link text.link_afterstringText after the link text.echoboolWhether to echo the menu or return it. Default true.depthintHow many levels of the hierarchy are to be included.
0 means all. Default 0.
Default 0.walkerobjectInstance of a custom walker class.theme_locationstringTheme location to be used. Must be registered with register_nav_menu() in order to be selectable by the user.items_wrapstringHow the list items should be wrapped. Uses printf() format with numbered placeholders. Default is a ul with an id and class.item_spacingstringWhether to preserve whitespace within the menu's HTML.
Accepts'preserve'or'discard'. Default'preserve'.
Return
string The HTML list content for the menu items.
Source
File: wp-includes/nav-menu-template.php. View all references
function walk_nav_menu_tree( $items, $depth, $args ) {
$walker = ( empty( $args->walker ) ) ? new Walker_Nav_Menu : $args->walker;
return $walker->walk( $items, $depth, $args );
}
Related
Uses
| Uses | Description |
|---|---|
| Walker::walk() wp-includes/class-wp-walker.php | Displays array of elements hierarchically. |
Used By
| Used By | Description |
|---|---|
| wp_ajax_add_menu_item() wp-admin/includes/ajax-actions.php | Ajax handler for adding a menu item. |
| _wp_ajax_menu_quick_search() wp-admin/includes/nav-menu.php | Prints the appropriate response to a menu quick search. |
| wp_nav_menu_item_post_type_meta_box() wp-admin/includes/nav-menu.php | Displays a meta box for a post type menu item. |
| wp_nav_menu_item_taxonomy_meta_box() wp-admin/includes/nav-menu.php | Displays a meta box for a taxonomy menu item. |
| wp_get_nav_menu_to_edit() wp-admin/includes/nav-menu.php | Returns the menu formatted to edit. |
| wp_nav_menu() wp-includes/nav-menu-template.php | Displays a navigation menu. |
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/walk_nav_menu_tree