WP_Customize_Nav_Menu_Item_Setting::preview() WordPress Method

The WP_Customize_Nav_Menu_Item_Setting::preview() method is used to preview changes to a nav menu item in the Customizer. This is done by displaying the nav menu item in the Customizer preview pane.

WP_Customize_Nav_Menu_Item_Setting::preview() #

Handle previewing the setting.


Description

Top ↑

See also


Top ↑

Return

(bool) False if method short-circuited due to no-op.


Top ↑

Source

File: wp-includes/customize/class-wp-customize-nav-menu-item-setting.php

	public function preview() {
		if ( $this->is_previewed ) {
			return false;
		}

		$undefined      = new stdClass();
		$is_placeholder = ( $this->post_id < 0 );
		$is_dirty       = ( $undefined !== $this->post_value( $undefined ) );
		if ( ! $is_placeholder && ! $is_dirty ) {
			return false;
		}

		$this->is_previewed              = true;
		$this->_original_value           = $this->value();
		$this->original_nav_menu_term_id = $this->_original_value['nav_menu_term_id'];
		$this->_previewed_blog_id        = get_current_blog_id();

		add_filter( 'wp_get_nav_menu_items', array( $this, 'filter_wp_get_nav_menu_items' ), 10, 3 );

		$sort_callback = array( __CLASS__, 'sort_wp_get_nav_menu_items' );
		if ( ! has_filter( 'wp_get_nav_menu_items', $sort_callback ) ) {
			add_filter( 'wp_get_nav_menu_items', array( __CLASS__, 'sort_wp_get_nav_menu_items' ), 1000, 3 );
		}

		// @todo Add get_post_metadata filters for plugins to add their data.

		return true;
	}


Top ↑

Changelog

Changelog
VersionDescription
4.4.0Added boolean return value.
4.3.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.