WP_Customize_Nav_Menu_Setting::filter_nav_menu_options_value() WordPress Method

The WP_Customize_Nav_Menu_Setting::filter_nav_menu_options_value() method is used to filter the nav menu options value before it is saved in the database.

WP_Customize_Nav_Menu_Setting::filter_nav_menu_options_value( array $nav_menu_options, int $menu_id, bool $auto_add ) #

Updates a nav_menu_options array.


Description

Top ↑

See also


Top ↑

Parameters

$nav_menu_options

(array)(Required)Array as returned by get_option( 'nav_menu_options' ).

$menu_id

(int)(Required)The term ID for the given menu.

$auto_add

(bool)(Required)Whether to auto-add or not.


Top ↑

Return

(array) (Maybe) modified nav_menu_options array.


Top ↑

Source

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

	protected function filter_nav_menu_options_value( $nav_menu_options, $menu_id, $auto_add ) {
		$nav_menu_options = (array) $nav_menu_options;
		if ( ! isset( $nav_menu_options['auto_add'] ) ) {
			$nav_menu_options['auto_add'] = array();
		}

		$i = array_search( $menu_id, $nav_menu_options['auto_add'], true );

		if ( $auto_add && false === $i ) {
			array_push( $nav_menu_options['auto_add'], $this->term_id );
		} elseif ( ! $auto_add && false !== $i ) {
			array_splice( $nav_menu_options['auto_add'], $i, 1 );
		}

		return $nav_menu_options;
	}


Top ↑

Changelog

Changelog
VersionDescription
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.