WP_Customize_Nav_Menu_Setting::value(): array
- Since
- 4.3.0
- Source
wp-includes/customize/class-wp-customize-nav-menu-setting.php:158
Compatibility
- WordPress
- since 4.3.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
array- Instance data.
Performance profile
How much work a call to WP_Customize_Nav_Menu_Setting::value() 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
- 9–51
- Plugin surface
- None
- Called by
- 5
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 64.
Nothing here hands control to plugin code.
5 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - querycontent query
get_term()one call below WP_Customize_Nav_Menu_Setting::value() - hookthird-party callbacks
apply_filters()one call below WP_Customize_Nav_Menu_Setting::value() - cacheobject cache
wp_cache_get()one call below WP_Customize_Nav_Menu_Setting::value() - serializeserialisation
maybe_unserialize()one call below WP_Customize_Nav_Menu_Setting::value()
Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 7 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Nav_Menu_Setting::value() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 9–11 | none |
| always | 14–16 | get_current_blog_id() |
| always | 16–18 | wp_get_nav_menu_object() |
| always | 18 | get_current_blog_id(), ->post_value() |
| always | 21–23 | get_current_blog_id(), wp_get_nav_menu_object() |
| always | 35–46 | wp_get_nav_menu_object(), array_keys(), wp_array_slice_assoc(), get_option() |
| always | 40–51 | get_current_blog_id(), wp_get_nav_menu_object(), array_keys(), wp_array_slice_assoc(), get_option() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 64 | 9–51 | 8 | |
| 8.5 | 64 | 9–51 | 8 | |
| 8.4 | 64 | 9–51 | 8 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 67 | 9–54 | 8 | |
| 8.2 | 67 | 9–54 | 8 | |
| 8.1 | 67 | 9–54 | 8 | |
| 7.4 | 67 | 9–54 | 8 |
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.
Uses · 6
- get_current_blog_id()Retrieves the current site ID.
- wp_get_nav_menu_object()Returns a navigation menu object.
- wp_array_slice_assoc()Extracts a slice of an array, given a list of keys.
- get_option()Retrieves an option value based on an option name.
- stdClass::__construct()
- WP_Customize_Nav_Menu_Setting::post_value()
Used by · 5
- WP_Customize_Nav_Menu_Setting::amend_customize_save_response()Export data for the JS client.
- WP_Customize_Nav_Menu_Setting::filter_nav_menu_options()Filters the nav_menu_options option to include this menu's auto_add preference.
- WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menu_object()Filters the wp_get_nav_menu_object() result to supply the previewed menu object.
- WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()Filters the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed.
- WP_Customize_Nav_Menu_Setting::preview()Handle previewing the setting.
Source code
public function value() { if ( $this->is_previewed && get_current_blog_id() === $this->_previewed_blog_id ) { $undefined = new stdClass(); // Symbol. $post_value = $this->post_value( $undefined ); if ( $undefined === $post_value ) { $value = $this->_original_value; } else { $value = $post_value; } } else { $value = false; // Note that a term_id of less than one indicates a nav_menu not yet inserted. if ( $this->term_id > 0 ) { $term = wp_get_nav_menu_object( $this->term_id ); if ( $term ) { $value = wp_array_slice_assoc( (array) $term, array_keys( $this->default ) ); $nav_menu_options = (array) get_option( 'nav_menu_options', array() ); $value['auto_add'] = false; if ( isset( $nav_menu_options['auto_add'] ) && is_array( $nav_menu_options['auto_add'] ) ) { $value['auto_add'] = in_array( $term->term_id, $nav_menu_options['auto_add'], true ); } } } if ( ! is_array( $value ) ) { $value = $this->default; } } return $value; }Changelog
Introduced in 4.3.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/customize/class-wp-customize-nav-menu-setting.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.