wp_get_nav_menu_object() WordPress Function
The wp_get_nav_menu_object() function retrieves a navigation menu object by its name. This function is useful for retrieving a specific navigation menu object when you know its name but don't have access to its ID.
wp_get_nav_menu_object( int|string|WP_Term $menu ) #
Returns a navigation menu object.
Parameters
- $menu
(int|string|WP_Term)(Required)Menu ID, slug, name, or object.
Return
(WP_Term|false) Menu object on success, false if $menu param isn't supplied or term does not exist.
Source
File: wp-includes/nav-menu.php
function wp_get_nav_menu_object( $menu ) { $menu_obj = false; if ( is_object( $menu ) ) { $menu_obj = $menu; } if ( $menu && ! $menu_obj ) { $menu_obj = get_term( $menu, 'nav_menu' ); if ( ! $menu_obj ) { $menu_obj = get_term_by( 'slug', $menu, 'nav_menu' ); } if ( ! $menu_obj ) { $menu_obj = get_term_by( 'name', $menu, 'nav_menu' ); } } if ( ! $menu_obj || is_wp_error( $menu_obj ) ) { $menu_obj = false; } /** * Filters the nav_menu term retrieved for wp_get_nav_menu_object(). * * @since 4.3.0 * * @param WP_Term|false $menu_obj Term from nav_menu taxonomy, or false if nothing had been found. * @param int|string|WP_Term $menu The menu ID, slug, name, or object passed to wp_get_nav_menu_object(). */ return apply_filters( 'wp_get_nav_menu_object', $menu_obj, $menu ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |