rest_validate_value_from_schema

Validate a value based on a schema.

Description

(true|WP_Error) rest_validate_value_from_schema( (mixed) $value, (array) $args, (string) $param = '' );

Returns (true|WP_Error)

Parameters (3)

0. $value (mixed): The value to validate.
1. $args (array): Schema array to use for validation.
2. $param — Optional. (string) => '': The parameter name, used in error messages.

Usage

if ( !function_exists( 'rest_validate_value_from_schema' ) ) { 
    require_once ABSPATH . WPINC . '/rest-api.php'; 
} 
  
// The value to validate. 
$value = null; 
  
// Schema array to use for validation. 
$args = array(); 
  
// The parameter name, used in error messages. 
$param = ''; 
  
// NOTICE! Understand what this does before running. 
$result = rest_validate_value_from_schema($value, $args, $param);

Defined (1)

The function is defined in the following location(s).

/wp-includes/rest-api.php

function rest_validate_value_from_schema( $value, $args, $param = '' ) { 
    if ( 'array' === $args['type'] ) { 
        if ( ! is_array( $value ) ) { 
            $value = preg_split( '/[\s, ]+/', $value ); 
        } 
        if ( ! wp_is_numeric_array( $value ) ) { 
            /** translators: 1: parameter, 2: type name */ 
            return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'array' ) ); 
        } 
        foreach ( $value as $index => $v ) { 
            $is_valid = rest_validate_value_from_schema( $v, $args['items'], $param . '[' . $index . ']' ); 
            if ( is_wp_error( $is_valid ) ) { 
                return $is_valid; 
            } 
        } 
    } 
    if ( ! empty( $args['enum'] ) ) { 
        if ( ! in_array( $value, $args['enum'], true ) ) { 
            /** translators: 1: parameter, 2: list of valid values */ 
            return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not one of %2$s.' ), $param, implode( ', ', $args['enum'] ) ) ); 
        } 
    } 
 
    if ( in_array( $args['type'], array( 'integer', 'number' ) ) && ! is_numeric( $value ) ) { 
        /** translators: 1: parameter, 2: type name */ 
        return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, $args['type'] ) ); 
    } 
 
    if ( 'integer' === $args['type'] && round( floatval( $value ) ) !== floatval( $value ) ) { 
        /** translators: 1: parameter, 2: type name */ 
        return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'integer' ) ); 
    } 
 
    if ( 'boolean' === $args['type'] && ! rest_is_boolean( $value ) ) { 
        /** translators: 1: parameter, 2: type name */ 
        return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $value, 'boolean' ) ); 
    } 
 
    if ( 'string' === $args['type'] && ! is_string( $value ) ) { 
        /** translators: 1: parameter, 2: type name */ 
        return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'string' ) ); 
    } 
 
    if ( isset( $args['format'] ) ) { 
        switch ( $args['format'] ) { 
            case 'date-time' : 
                if ( ! rest_parse_date( $value ) ) { 
                    return new WP_Error( 'rest_invalid_date', __( 'Invalid date.' ) ); 
                } 
                break; 
 
            case 'email' : 
                // is_email() checks for 3 characters (a@b), but 
                // wp_handle_comment_submission() requires 6 characters (a@b.co) 
                // 
                // https://core.trac.wordpress.org/ticket/38506 
                if ( ! is_email( $value ) || strlen( $value ) < 6 ) { 
                    return new WP_Error( 'rest_invalid_email', __( 'Invalid email address.' ) ); 
                } 
                break; 
            case 'ip' : 
                if ( ! rest_is_ip_address( $value ) ) { 
                    /** translators: %s: IP address */ 
                    return new WP_Error( 'rest_invalid_param', sprintf( __( '%s is not a valid IP address.' ), $value ) ); 
                } 
                break; 
        } 
    } 
 
    if ( in_array( $args['type'], array( 'number', 'integer' ), true ) && ( isset( $args['minimum'] ) || isset( $args['maximum'] ) ) ) { 
        if ( isset( $args['minimum'] ) && ! isset( $args['maximum'] ) ) { 
            if ( ! empty( $args['exclusiveMinimum'] ) && $value <= $args['minimum'] ) { 
                /** translators: 1: parameter, 2: minimum number */ 
                return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must be greater than %2$d (exclusive)' ), $param, $args['minimum'] ) ); 
            } elseif ( empty( $args['exclusiveMinimum'] ) && $value < $args['minimum'] ) { 
                /** translators: 1: parameter, 2: minimum number */ 
                return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must be greater than %2$d (inclusive)' ), $param, $args['minimum'] ) ); 
            } 
        } elseif ( isset( $args['maximum'] ) && ! isset( $args['minimum'] ) ) { 
            if ( ! empty( $args['exclusiveMaximum'] ) && $value >= $args['maximum'] ) { 
                /** translators: 1: parameter, 2: maximum number */ 
                return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must be less than %2$d (exclusive)' ), $param, $args['maximum'] ) ); 
            } elseif ( empty( $args['exclusiveMaximum'] ) && $value > $args['maximum'] ) { 
                /** translators: 1: parameter, 2: maximum number */ 
                return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must be less than %2$d (inclusive)' ), $param, $args['maximum'] ) ); 
            } 
        } elseif ( isset( $args['maximum'] ) && isset( $args['minimum'] ) ) { 
            if ( ! empty( $args['exclusiveMinimum'] ) && ! empty( $args['exclusiveMaximum'] ) ) { 
                if ( $value >= $args['maximum'] || $value <= $args['minimum'] ) { 
                    /** translators: 1: parameter, 2: minimum number, 3: maximum number */ 
                    return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must be between %2$d (exclusive) and %3$d (exclusive)' ), $param, $args['minimum'], $args['maximum'] ) ); 
                } 
            } elseif ( empty( $args['exclusiveMinimum'] ) && ! empty( $args['exclusiveMaximum'] ) ) { 
                if ( $value >= $args['maximum'] || $value < $args['minimum'] ) { 
                    /** translators: 1: parameter, 2: minimum number, 3: maximum number */ 
                    return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must be between %2$d (inclusive) and %3$d (exclusive)' ), $param, $args['minimum'], $args['maximum'] ) ); 
                } 
            } elseif ( ! empty( $args['exclusiveMinimum'] ) && empty( $args['exclusiveMaximum'] ) ) { 
                if ( $value > $args['maximum'] || $value <= $args['minimum'] ) { 
                    /** translators: 1: parameter, 2: minimum number, 3: maximum number */ 
                    return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must be between %2$d (exclusive) and %3$d (inclusive)' ), $param, $args['minimum'], $args['maximum'] ) ); 
                } 
            } elseif ( empty( $args['exclusiveMinimum'] ) && empty( $args['exclusiveMaximum'] ) ) { 
                if ( $value > $args['maximum'] || $value < $args['minimum'] ) { 
                    /** translators: 1: parameter, 2: minimum number, 3: maximum number */ 
                    return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must be between %2$d (inclusive) and %3$d (inclusive)' ), $param, $args['minimum'], $args['maximum'] ) ); 
                } 
            } 
        } 
    } 
 
    return true; 
}