On this page
wp_get_nav_menu_object( int|string|WP_Term $menu ): WP_Term|false
Returns a navigation menu object.
Parameters
$menuint|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. View all references
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 );
}
Hooks
- apply_filters( 'wp_get_nav_menu_object',
WP_Term|false $menu_obj ,int|string|WP_Term $menu ) -
Filters the nav_menu term retrieved for wp_get_nav_menu_object() .
Related
Uses
| Uses | Description |
|---|---|
| get_term_by() wp-includes/taxonomy.php | Gets all term data from database by term field and data. |
| get_term() wp-includes/taxonomy.php | Gets all term data from database by term ID. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
| is_wp_error() wp-includes/load.php | Checks whether the given variable is a WordPress Error. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Menus_Controller::get_term() wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php | Gets the term, if the ID is valid. |
| WP_REST_Menus_Controller::prepare_item_for_response() wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php | Prepares a single term output for response. |
| WP_REST_Menus_Controller::create_item() wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php | Creates a single term in a taxonomy. |
| wp_get_nav_menu_name() wp-includes/nav-menu.php | Returns the name of a navigation menu. |
| WP_Customize_Nav_Menu_Setting::value() wp-includes/customize/class-wp-customize-nav-menu-setting.php | Get the instance data for a given widget setting. |
| wp_get_nav_menu_to_edit() wp-admin/includes/nav-menu.php | Returns the menu formatted to edit. |
| WP_Nav_Menu_Widget::widget() wp-includes/widgets/class-wp-nav-menu-widget.php | Outputs the content for the current Navigation Menu widget instance. |
| wp_nav_menu() wp-includes/nav-menu-template.php | Displays a navigation menu. |
| wp_delete_nav_menu() wp-includes/nav-menu.php | Deletes a navigation menu. |
| wp_update_nav_menu_object() wp-includes/nav-menu.php | Saves the properties of a menu or create a new menu with those properties. |
| wp_update_nav_menu_item() wp-includes/nav-menu.php | Saves the properties of a menu item or create a new one. |
| wp_get_nav_menu_items() wp-includes/nav-menu.php | Retrieves all menu items of a navigation menu. |
| is_nav_menu() wp-includes/nav-menu.php | Determines whether the given ID is 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/wp_get_nav_menu_object