rest_validate_boolean_value_from_schema( mixed $value, string $param )
Validates a boolean value based on a schema.
Parameters
- $value
-
(mixed) (Required) The value to validate.
- $param
-
(string) (Required) The parameter name, used in error messages.
Return
(true|WP_Error)
Source
File: wp-includes/rest-api.php
function rest_validate_boolean_value_from_schema( $value, $param ) { if ( ! rest_is_boolean( $value ) ) { return new WP_Error( 'rest_invalid_type', /* translators: 1: Parameter, 2: Type name. */ sprintf( __( '%1$s is not of type %2$s.' ), $param, 'boolean' ), array( 'param' => $param ) ); } return true; }
Changelog
Version | Description |
---|---|
5.7.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/rest_validate_boolean_value_from_schema