wp_get_nav_menu_object( int|string|WP_Term $menu ): WP_Term|false
- Since
- 3.0.0
- Source
wp-includes/nav-menu.php:18
Compatibility
- WordPress
- since 3.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
Return value
WP_Term|false- Menu object on success, false if $menu param isn't supplied or term does not exist.
Performance profile
How much work a call to wp_get_nav_menu_object() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 13–38
- Plugin surface
- 1 hook
- Called by
- 16
Reaches the database via get_term().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 38.
Third-party callbacks on 'wp_get_nav_menu_object' run inside this call, and their cost is not bounded by anything here.
16 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_term()called directly - hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_nav_menu_object() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!$menu | 13–14 | apply_filters() |
$menu | 16–18 | is_wp_error(), apply_filters() |
| always | 22–24 | get_term(), is_wp_error(), apply_filters() |
| always | 29–31 | get_term(), get_term_by(), is_wp_error(), apply_filters() |
!$menu | 33–34 | get_term(), get_term_by(), get_term_by(), apply_filters() |
| always | 36–38 | get_term(), get_term_by(), get_term_by(), is_wp_error(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 38 instructions, 13–38 executed per call, 7 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while wp_get_nav_menu_object() runs, in this order:
- apply_filters( wp_get_nav_menu_object )filterline 49 (+31 into the body)
Filters the nav_menu term retrieved for wp_get_nav_menu_object().
Uses · 4
- get_term()Gets all term data from database by term ID.
- get_term_by()Gets all term data from database by term field and data.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 16
- WP_Customize_Nav_Menu_Setting::value()Get the instance data for a given widget setting.
- WP_Nav_Menu_Widget::widget()Outputs the content for the current Navigation Menu widget instance.
- WP_Navigation_Fallback::get_nav_menu_at_primary_location()Gets the classic menu assigned to the `primary` navigation menu location if it exists.
- WP_REST_Menus_Controller::create_item()Creates a single term in a taxonomy.
- WP_REST_Menus_Controller::get_term()Gets the term, if the ID is valid.
- WP_REST_Menus_Controller::prepare_item_for_response()Prepares a single term output for response.
- block_core_navigation_get_classic_menu_fallback()Get the classic navigation menu to use as a fallback.
- block_core_navigation_get_menu_items_at_location()Returns the menu items for a WordPress menu location.
- is_nav_menu()Determines whether the given ID is a navigation menu.
- wp_delete_nav_menu()Deletes a navigation menu.
- wp_get_nav_menu_items()Retrieves all menu items of a navigation menu.
- wp_get_nav_menu_name()Returns the name of a navigation menu.
Show all 16
- wp_get_nav_menu_to_edit()Returns the menu formatted to edit.
- wp_nav_menu()Displays a navigation menu.
- wp_update_nav_menu_item()Saves the properties of a menu item or create a new one.
- wp_update_nav_menu_object()Saves the properties of a menu or create a new menu with those properties.
Source code
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 );}Changelog
Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/nav-menu.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.