get_registered_nav_menus(): string[]
- Since
- 3.0.0
- Source
wp-includes/nav-menu.php:149
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.
Return value
string[]- Associative array of registered navigation menu descriptions keyed by their location. If none are registered, an empty array.
Performance profile
How much work a call to get_registered_nav_menus() 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
- Trivial
- Scaling
- Constant
- Instructions
- 3–4
- Plugin surface
- None
- Called by
- 9
Touches nothing outside its own arguments.
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 4.
Nothing here hands control to plugin code.
9 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_registered_nav_menus() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 3–4 | none |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 4 instructions, 3–4 executed per call, 1 branch. 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.
Used by · 9
- WP_Customize_Nav_Menu_Locations_Control::content_template()JS/Underscore template for the control UI.
- WP_Customize_Nav_Menus::customize_register()Adds the customizer settings and controls.
- WP_Customize_Nav_Menus::enqueue_scripts()Enqueues scripts and styles for Customizer pane.
- WP_REST_Menu_Locations_Controller::get_item()Retrieves a specific menu location.
- WP_REST_Menu_Locations_Controller::get_items()Retrieves all menu locations, depending on user context.
- WP_REST_Menus_Controller::get_item_schema()Retrieves the term's schema, conforming to JSON Schema.
- WP_REST_Menus_Controller::handle_locations()Updates the menu's locations from a REST request.
- has_nav_menu()Determines whether a registered nav menu location has a menu assigned to it.
- wp_map_nav_menu_locations()Maps nav menu locations according to assignments in previously active theme.
Source code
function get_registered_nav_menus() { global $_wp_registered_nav_menus; return $_wp_registered_nav_menus ?? array();}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 7.1.0 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.