WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

is_nav_menu()

is_nav_menu( int|string|WP_Term $menu ): bool

In this article

Back to top

Determines whether the given ID is a navigation menu.

Description

Returns true if it is; false otherwise.

Parameters

$menuint|string|WP_Termrequired
Menu ID, slug, name, or object of menu to check.

Return

bool Whether the menu exists.

Source

function is_nav_menu( $menu ) {
	if ( ! $menu ) {
		return false;
	}

	$menu_obj = wp_get_nav_menu_object( $menu );

	if (
		$menu_obj &&
		! is_wp_error( $menu_obj ) &&
		! empty( $menu_obj->taxonomy ) &&
		'nav_menu' === $menu_obj->taxonomy
	) {
		return true;
	}

	return false;
}

View all references View on Trac View on GitHub

UsesDescription
wp_get_nav_menu_object()wp-includes/nav-menu.php

Returns a navigation menu object.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Used byDescription
WP_Classic_To_Block_Menu_Converter::convert()wp-includes/class-wp-classic-to-block-menu-converter.php

Converts a Classic Menu to blocks.

wp_save_nav_menu_items()wp-admin/includes/nav-menu.php

Save posted nav menu item data.

wp_get_nav_menu_to_edit()wp-admin/includes/nav-menu.php

Returns the menu formatted to edit.

Changelog

VersionDescription
3.0.0Introduced.

User Contributed Notes

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