wc_rest_validate_reports_request_arg( mixed $value, WP_REST_Request $request, string $param )
Validate reports request arguments.
Description Description
Parameters Parameters
- $value
-
(Required) Value to valdate.
- $request
-
(Required) Request instance.
- $param
-
(Required) Param to validate.
Return Return
(WP_Error|boolean)
Source Source
File: includes/wc-rest-functions.php
function wc_rest_validate_reports_request_arg( $value, $request, $param ) { $attributes = $request->get_attributes(); if ( ! isset( $attributes['args'][ $param ] ) || ! is_array( $attributes['args'][ $param ] ) ) { return true; } $args = $attributes['args'][ $param ]; if ( 'string' === $args['type'] && ! is_string( $value ) ) { /* translators: 1: param 2: type */ return new WP_Error( 'woocommerce_rest_invalid_param', sprintf( __( '%1$s is not of type %2$s', 'woocommerce' ), $param, 'string' ) ); } if ( 'date' === $args['format'] ) { $regex = '#^\d{4}-\d{2}-\d{2}$#'; if ( ! preg_match( $regex, $value, $matches ) ) { return new WP_Error( 'woocommerce_rest_invalid_date', __( 'The date you provided is invalid.', 'woocommerce' ) ); } } return true; }
Changelog Changelog
Version | Description |
---|---|
2.6.0 | Introduced. |