rest_validate_integer_value_from_schema() │ WP 5.7.0

Validates an integer value based on a schema.

No Hooks.

Return

true|WP_Error.

Usage

rest_validate_integer_value_from_schema( $value, $args, $param );

$value(mixed) (required)

The value to validate.

$args(array) (required)

Schema array to use for validation.

$param(string) (required)

The parameter name, used in error messages.

Changelog

rest_validate_integer_value_from_schema() rest validate integer value from schema code ^{WP 6.1.1}

function rest_validate_integer_value_from_schema( $value, $args, $param ) {
	$is_valid_number = rest_validate_number_value_from_schema( $value, $args, $param );
	if ( is_wp_error( $is_valid_number ) ) {
		return $is_valid_number;
	}

	if ( ! rest_is_integer( $value ) ) {
		return new WP_Error(
			'rest_invalid_type',
			/* translators: 1: Parameter, 2: Type name. */
			sprintf( __( '%1$s is not of type %2$s.' ), $param, 'integer' ),
			array( 'param' => $param )
		);
	}

	return true;
}