WP_Customize_Nav_Menu_Item_Setting::value(): array|false

Compatibility

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|false

Instance data array, or false if the item is marked for deletion.

Performance profile

How much work a call to WP_Customize_Nav_Menu_Item_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

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

10–62

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 79.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()one call below WP_Customize_Nav_Menu_Item_Setting::value()

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 · 27 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Nav_Menu_Item_Setting::value() can have, taken from its control-flow graph on PHP 8.5.

Uses · 8

• get_current_blog_id()Retrieves the current site ID.
• get_post()Retrieves post data given a post ID or post object.
• wp_setup_nav_menu_item()Decorates a menu item object with the shared navigation menu item properties.
• stdClass::__construct()
• WP_Customize_Nav_Menu_Item_Setting::post_value()
• WP_Customize_Nav_Menu_Item_Setting::populate_value()Ensure that the value is fully populated with the necessary properties.
• WP_Customize_Nav_Menu_Item_Setting::get_type_label()Get type label.
• WP_Customize_Nav_Menu_Item_Setting::get_original_title()Get original title.

Used by · 3

• WP_Customize_Nav_Menu_Item_Setting::filter_wp_get_nav_menu_items()Filters the wp_get_nav_menu_items() result to supply the previewed menu items.
• WP_Customize_Nav_Menu_Item_Setting::preview()Handle previewing the setting.
• WP_Customize_Nav_Menu_Item_Setting::value_as_wp_post_nav_menu_item()Get the value emulated into a WP_Post and set up as a nav_menu_item.

Source code

View on Trac ↗View on GitHub ↗

211	public function value() {212		$type_label = null;213		if ( $this->is_previewed && get_current_blog_id() === $this->_previewed_blog_id ) {214			$undefined  = new stdClass(); // Symbol.215			$post_value = $this->post_value( $undefined );216 217			if ( $undefined === $post_value ) {218				$value = $this->_original_value;219			} else {220				$value = $post_value;221			}222		} elseif ( isset( $this->value ) ) {223			$value = $this->value;224		} else {225			$value = false;226 227			// Note that an ID of less than one indicates a nav_menu not yet inserted.228			if ( $this->post_id > 0 ) {229				$post = get_post( $this->post_id );230				if ( $post && self::POST_TYPE === $post->post_type ) {231					$is_title_empty = empty( $post->post_title );232					$value          = (array) wp_setup_nav_menu_item( $post );233					if ( isset( $value['type_label'] ) ) {234						$type_label = $value['type_label'];235					}236					if ( $is_title_empty ) {237						$value['title'] = '';238					}239				}240			}241 242			if ( ! is_array( $value ) ) {243				$value = $this->default;244			}245 246			// Cache the value for future calls to avoid having to re-call wp_setup_nav_menu_item().247			$this->value = $value;248			$this->populate_value();249			$value = $this->value;250		}251 252		// These properties are read-only and are part of the setting for use in the Customizer UI.253		if ( is_array( $value ) ) {254			$value_obj               = (object) $value;255			$value['type_label']     = isset( $type_label ) ? $type_label : $this->get_type_label( $value_obj );256			$value['original_title'] = $this->get_original_title( $value_obj );257		}258 259		return $value;260	}

Changelog

Introduced in 4.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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/customize/class-wp-customize-nav-menu-item-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.