W3cubDocs

/WordPress

WP_Customize_Nav_Menu_Setting::sanitize( array $value )

Sanitize an input.

Description

Note that parent::sanitize() erroneously does wp_unslash() on $value, but we remove that in this override.

Parameters

$value

(array) (Required) The value to sanitize.

Return

(array|false|null) Null if an input isn't valid. False if it is marked for deletion. Otherwise the sanitized value.

Source

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

public function sanitize( $value ) {
		// Menu is marked for deletion.
		if ( false === $value ) {
			return $value;
		}

		// Invalid.
		if ( ! is_array( $value ) ) {
			return null;
		}

		$default = array(
			'name'        => '',
			'description' => '',
			'parent'      => 0,
			'auto_add'    => false,
		);
		$value   = array_merge( $default, $value );
		$value   = wp_array_slice_assoc( $value, array_keys( $default ) );

		$value['name']        = trim( esc_html( $value['name'] ) ); // This sanitization code is used in wp-admin/nav-menus.php.
		$value['description'] = sanitize_text_field( $value['description'] );
		$value['parent']      = max( 0, intval( $value['parent'] ) );
		$value['auto_add']    = ! empty( $value['auto_add'] );

		if ( '' === $value['name'] ) {
			$value['name'] = _x( '(unnamed)', 'Missing menu name.' );
		}

		/** This filter is documented in wp-includes/class-wp-customize-setting.php */
		return apply_filters( "customize_sanitize_{$this->id}", $value, $this );
	}

Uses

Uses Description
wp-includes/l10n.php: _x()

Retrieve translated string with gettext context.
wp-includes/formatting.php: sanitize_text_field()

Sanitizes a string from user input or from the database.
wp-includes/formatting.php: esc_html()

Escaping for HTML blocks.
wp-includes/functions.php: wp_array_slice_assoc()

Extract a slice of an array, given a list of keys.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/class-wp-customize-setting.php: customize_sanitize_{$this->id}

Filters a Customize setting value in un-slashed form.

Changelog

Version Description
4.3.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_customize_nav_menu_setting/sanitize