A WordPress-centric search engine for devs and theme authors



rest_validate_integer_value_from_schema ›

Since5.7.0
Deprecatedn/a
rest_validate_integer_value_from_schema ( $value, $args, $param )
Parameters: (3)
  • (mixed) $value The value to validate.
    Required: Yes
  • (array) $args Schema array to use for validation.
    Required: Yes
  • (string) $param The parameter name, used in error messages.
    Required: Yes
Returns:
  • (true|WP_Error)
Defined at:
Codex:

Validates an integer value based on a schema.



Source

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;
}