On this page
rest_validate_boolean_value_from_schema( mixed $value, string $param ): true|WP_Error
Validates a boolean value based on a schema.
Parameters
$valuemixed Required-
The value to validate.
$paramstring Required-
The parameter name, used in error messages.
Return
true|WP_Error
Source
File: wp-includes/rest-api.php. View all references
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;
}
Related
Uses
| Uses | Description |
|---|---|
| rest_is_boolean() wp-includes/rest-api.php | Determines if a given value is boolean-like. |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| WP_Error::__construct() wp-includes/class-wp-error.php | Initializes the error. |
Used By
| Used By | Description |
|---|---|
| rest_validate_value_from_schema() wp-includes/rest-api.php | Validate a value based on a schema. |
Changelog
| Version | Description |
|---|---|
| 5.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/rest_validate_boolean_value_from_schema