WP_Customize_Nav_Menu_Setting::update( array|false $value ): null|void

Description

Parameters

$valuearray|false

The value to update. Note that slug cannot be updated via wp_update_nav_menu_object(). If false, then the menu will be deleted entirely.

• $namestring

  The name of the menu to save.

• $descriptionstringdefault: empty string

  The term description.

• $parentintdefault: 0

  The id of the parent term.

• $auto_addbooldefault: false

  Whether pages will auto_add to this menu.

Return

null|void

Uses · 10

• add_filter()Adds a callback function to a filter hook.
• wp_delete_nav_menu()Deletes a navigation menu.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_array_slice_assoc()Extracts a slice of an array, given a list of keys.
• wp_update_nav_menu_object()Saves the properties of a menu or create a new menu with those properties.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• __()Retrieves the translation of $text.
• get_option()Retrieves an option value based on an option name.
• update_option()Updates the value of an option that was already added.
• WP_Customize_Nav_Menu_Setting::filter_nav_menu_options_value()Updates a nav_menu_options array.

Source

View on Trac ↗View on GitHub ↗

483	protected function update( $value ) {484		if ( $this->is_updated ) {485			return;486		}487 488		$this->is_updated = true;489		$is_placeholder   = ( $this->term_id < 0 );490		$is_delete        = ( false === $value );491 492		add_filter( 'customize_save_response', array( $this, 'amend_customize_save_response' ) );493 494		$auto_add = null;495		if ( $is_delete ) {496			// If the current setting term is a placeholder, a delete request is a no-op.497			if ( $is_placeholder ) {498				$this->update_status = 'deleted';499			} else {500				$r = wp_delete_nav_menu( $this->term_id );501 502				if ( is_wp_error( $r ) ) {503					$this->update_status = 'error';504					$this->update_error  = $r;505				} else {506					$this->update_status = 'deleted';507					$auto_add            = false;508				}509			}510		} else {511			// Insert or update menu.512			$menu_data              = wp_array_slice_assoc( $value, array( 'description', 'parent' ) );513			$menu_data['menu-name'] = $value['name'];514 515			$menu_id              = $is_placeholder ? 0 : $this->term_id;516			$r                    = wp_update_nav_menu_object( $menu_id, wp_slash( $menu_data ) );517			$original_name        = $menu_data['menu-name'];518			$name_conflict_suffix = 1;519			while ( is_wp_error( $r ) && 'menu_exists' === $r->get_error_code() ) {520				$name_conflict_suffix += 1;521				/* translators: 1: Original menu name, 2: Duplicate count. */522				$menu_data['menu-name'] = sprintf( __( '%1$s (%2$d)' ), $original_name, $name_conflict_suffix );523				$r                      = wp_update_nav_menu_object( $menu_id, wp_slash( $menu_data ) );524			}525 526			if ( is_wp_error( $r ) ) {527				$this->update_status = 'error';528				$this->update_error  = $r;529			} else {530				if ( $is_placeholder ) {531					$this->previous_term_id = $this->term_id;532					$this->term_id          = $r;533					$this->update_status    = 'inserted';534				} else {535					$this->update_status = 'updated';536				}537 538				$auto_add = $value['auto_add'];539			}540		}541 542		if ( null !== $auto_add ) {543			$nav_menu_options = $this->filter_nav_menu_options_value(544				(array) get_option( 'nav_menu_options', array() ),545				$this->term_id,546				$auto_add547			);548			update_option( 'nav_menu_options', $nav_menu_options );549		}550 551		if ( 'inserted' === $this->update_status ) {552			// Make sure that new menus assigned to nav menu locations use their new IDs.553			foreach ( $this->manager->settings() as $setting ) {554				if ( ! preg_match( '/^nav_menu_locations\[/', $setting->id ) ) {555					continue;556				}557 558				$post_value = $setting->post_value( null );559				if ( ! is_null( $post_value ) && (int) $post_value === $this->previous_term_id ) {560					$this->manager->set_post_value( $setting->id, $this->term_id );561					$setting->save();562				}

History

Introduced in 4.3.0. One change between 6.7.7 and 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.8.8 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.