概述

rest_validate_boolean_value_from_schema() 是一个 WordPress REST API 函数，用于根据模式验证布尔值。它检查给定值是否为布尔类型，并返回验证结果或错误信息。

关键要点

• 函数接受两个参数：$value（要验证的值）和 $param（参数名，用于错误消息）。
• 返回值：如果验证通过返回 true，否则返回一个 WP_Error 对象，包含错误代码 'rest_invalid_type' 和描述性消息。
• 内部使用 rest_is_boolean() 函数来判断值是否为布尔类型。
• 此函数在 WordPress 5.7.0 版本中引入，常用于 rest_validate_value_from_schema() 中。

代码示例

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