Validates setting values.

Description

Validation is skipped for unregistered settings or for values that are already null since they will be skipped anyway. Sanitization is applied to values that pass validation, and values that become null or WP_Error after sanitizing are marked invalid.

See also

• WP_REST_Request::has_valid_params()
• WP_Customize_Setting::validate()

Parameters

$setting_valuesarrayrequired

Mapping of setting IDs to values to validate and sanitize.

$optionsarrayoptional

Options.

• validate_existence bool
  Whether a setting’s existence will be checked.
• validate_capability bool
  Whether the setting capability will be checked.

Default:array()

Return

Source

public function validate_setting_values( $setting_values, $options = array() ) {
	$options = wp_parse_args(
		$options,
		array(
			'validate_capability' => false,
			'validate_existence'  => false,
		)
	);

	$validities = array();
	foreach ( $setting_values as $setting_id => $unsanitized_value ) {
		$setting = $this->get_setting( $setting_id );
		if ( ! $setting ) {
			if ( $options['validate_existence'] ) {
				$validities[ $setting_id ] = new WP_Error( 'unrecognized', __( 'Setting does not exist or is unrecognized.' ) );
			}
			continue;
		}
		if ( $options['validate_capability'] && ! current_user_can( $setting->capability ) ) {
			$validity = new WP_Error( 'unauthorized', __( 'Unauthorized to modify setting due to capability.' ) );
		} else {
			if ( is_null( $unsanitized_value ) ) {
				continue;
			}
			$validity = $setting->validate( $unsanitized_value );
		}
		if ( ! is_wp_error( $validity ) ) {
			/** This filter is documented in wp-includes/class-wp-customize-setting.php */
			$late_validity = apply_filters( "customize_validate_{$setting->id}", new WP_Error(), $unsanitized_value, $setting );
			if ( is_wp_error( $late_validity ) && $late_validity->has_errors() ) {
				$validity = $late_validity;
			}
		}
		if ( ! is_wp_error( $validity ) ) {
			$value = $setting->sanitize( $unsanitized_value );
			if ( is_null( $value ) ) {
				$validity = false;
			} elseif ( is_wp_error( $value ) ) {
				$validity = $value;
			}
		}
		if ( false === $validity ) {
			$validity = new WP_Error( 'invalid_value', __( 'Invalid value.' ) );
		}
		$validities[ $setting_id ] = $validity;
	}
	return $validities;
}

View all references View on Trac View on GitHub

Changelog