wp_get_nav_menu_object( int|string|WP_Term $menu )

Returns a navigation menu object.

Contents

Description Description

Parameters Parameters

$menu

(int|string|WP_Term) (Required) Menu ID, slug, name, or object.

Top ↑

Return Return

(WP_Term|false) False if $menu param isn't supplied or term does not exist, menu object if successful.

Top ↑

Source 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 code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
3.0.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/nav-menu.php: wp_get_nav_menu_object

Filters the nav_menu term retrieved for wp_get_nav_menu_object().
wp-includes/taxonomy.php: get_term_by()

Get all Term data from database by Term field and data.
wp-includes/taxonomy.php: get_term()

Get all Term data from database by Term ID.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/nav-menu.php: wp_get_nav_menu_name()

Returns the name of a navigation menu.
wp-includes/customize/class-wp-customize-nav-menu-setting.php: WP_Customize_Nav_Menu_Setting::value()

Get the instance data for a given widget setting.
wp-admin/includes/nav-menu.php: wp_get_nav_menu_to_edit()

Returns the menu formatted to edit.
wp-includes/widgets/class-wp-nav-menu-widget.php: WP_Nav_Menu_Widget::widget()

Outputs the content for the current Navigation Menu widget instance.
wp-includes/nav-menu-template.php: wp_nav_menu()

Displays a navigation menu.
wp-includes/nav-menu.php: wp_delete_nav_menu()

Delete a Navigation Menu.
wp-includes/nav-menu.php: wp_update_nav_menu_object()

Save the properties of a menu or create a new menu with those properties.
wp-includes/nav-menu.php: wp_update_nav_menu_item()

Save the properties of a menu item or create a new one.
wp-includes/nav-menu.php: wp_get_nav_menu_items()

Retrieves all menu items of a navigation menu.
wp-includes/nav-menu.php: is_nav_menu()

Check if the given ID is a navigation menu.
Show 5 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Examples

    // By name.
$menu = wp_get_nav_menu_object( 'wpdocs mainmenu' );

// By slug.
$menu = wp_get_nav_menu_object( 'wpdocs-mainmenu' );

// By ID.
$menu_name = 'wpdocs mainmenu';
$menu_obj  = get_term_by( 'name', $menu_name, 'nav_menu' );
$menu_id   = $menu_obj->term_id;
$menu = wp_get_nav_menu_object( $menu_id );


// By location.
$menu_name = 'primary';
$locations = get_nav_menu_locations();
$menu_id   = $locations[ $menu_name ] ;
wp_get_nav_menu_object( $menu_id );

    Expand full source codeCollapse full source code

You must log in before being able to contribute a note or feedback.