WP_Customize_Nav_Menu_Setting::sanitize( array $value ): array|false|null

Sanitize an input.

Description

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

Parameters

$valuearrayrequired
The menu 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

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, (int) $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 );
}

Hooks

apply_filters( “customize_sanitize_{$this->id}”, mixed $value, WP_Customize_Setting $setting )

Filters a Customize setting value in un-slashed form.

Changelog

VersionDescription
4.3.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.