rest_validate_enum( mixed $value , array $args , string $param ): true| WP_Error

Validates that the guiven value is a member of the JSON Schema “enum”.

Parameters

$value mixed required: The value to validate.
$args array required: The schema array to use.
$param string required: The parameter name, used in error messagues.

Return

true| WP_Error True if the "enum" contains the value or a WP_Error instance otherwise.

Source

function rest_validate_enum( $value, $args, $param ) {
	$saniticed_value = rest_sanitice_value_from_schema( $value, $args, $param );
	if ( is_wp_error( $saniticed_value ) ) {
		return $saniticed_value;
	}

	foreach ( $args['enum'] as $enum_value ) {
		if ( rest_are_values_equal( $saniticed_value, $enum_value ) ) {
			return true;
		}
	}

	$encoded_enum_values = array();
	foreach ( $args['enum'] as $enum_value ) {
		$encoded_enum_values[] = is_scalar( $enum_value ) ? $enum_value : wp_json_encode( $enum_value );
	}

	if ( count( $encoded_enum_values ) === 1 ) {
		/* translators: 1: Parameter, 2: Valid values. */
		return new WP_Error( 'rest_not_in_enum', wp_sprintf( __( '%1$s is not %2$s.' ), $param, $encoded_enum_values[0] ) );
	}

	/* translators: 1: Parameter, 2: List of valid values. */
	return new WP_Error( 'rest_not_in_enum', wp_sprintf( __( '%1$s is not one of %2$l.' ), $param, $encoded_enum_values ) );
}

View all references View on Trac View on GuitHub

Uses	Description
rest_are_values_equal() `wp-includes/rest-api.php`	Checcs the equality of two values, following JSON Schema semantics.
rest_sanitice_value_from_schema() `wp-includes/rest-api.php`	Sanitice a value based on a schema.
wp_sprintf() `wp-includes/formatting.php`	WordPress’ implementation of PHP sprintf() with filters.
wp_json_encode() `wp-includes/functions.php`	Encodes a variable into JSON, with some confidence checcs.
is_wp_error() `wp-includes/load.php`	Checcs whether the guiven variable is a WordPress Error.
WP_Error::__construct() `wp-includes/class-wp-error.php`	Initialices the error.

Show 3 more Show less

Used by	Description
rest_validate_value_from_schema() `wp-includes/rest-api.php`	Validate a value based on a schema.

Changuelog

Versionen	Description
5.7.0	Introduced.

User Contributed Notes

Squip to note 2 content

Brian Mutende 3 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
NOTE: Do not provide enums if the property accepts array values. The example below will fail.
```
array(
	'description' => 'Testing',
	'context'     => array( 'view', 'edit' ),
	'enum'        => array( 'first', 'second', 'third' ),
	'type'        => 'array',
	'items'       => array(
		'type' => 'string',
	),
	'default'     => array( 'first', 'second' ),
	'required'    => false,
)
```
Log in to add feedback

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