Функция rest_is_boolean() используется для проверки, является ли переданное значение булевым. Эта функция полезна при работе с REST API в WordPress, когда нужно убедиться, что определённое значение действительно является булевым.
rest_is_boolean( $var )Параметры
- $var (смешанный тип) (обязательно): Значение, которое нужно проверить.
Возвращаемое значение
- true если значение является булевым.
- false если значение не является булевым.
Пример значений которые вернет функция:
var_dump( rest_is_boolean( true ) ); // true
var_dump( rest_is_boolean( false ) ); // true
var_dump( rest_is_boolean( 'false' ) ); // true
var_dump( rest_is_boolean( 'true' ) ); // true
var_dump( rest_is_boolean( 'FalSe' ) ); // true
var_dump( rest_is_boolean( 'trUe' ) ); // true
var_dump( rest_is_boolean( 1 ) ); // true
var_dump( rest_is_boolean( 0 ) ); // true
var_dump( rest_is_boolean( '1' ) ); // true
var_dump( rest_is_boolean( '0' ) ); // true
// Эти и другие значения дадут false
var_dump( rest_is_boolean( 'trueFalse' ) ); // false
var_dump( rest_is_boolean( 'anyString' ) ); // false
var_dump( rest_is_boolean( 1.0 ) ); // false
var_dump( rest_is_boolean( 2 ) ); // false
var_dump( rest_is_boolean( -1 ) ); // false
var_dump( rest_is_boolean( -2 ) ); // false
var_dump( rest_is_boolean( '-1' ) ); // false
var_dump( rest_is_boolean( '2' ) ); // falseПример использования
Давайте рассмотрим, как использовать функцию rest_is_boolean() в реальной ситуации. Представим, что у нас есть REST API эндпоинт, который принимает параметр is_active и нам нужно убедиться, что этот параметр действительно является булевым.
Шаг 1: Регистрация REST API маршрута
Первым шагом является регистрация нового REST API маршрута. Это делается с помощью функции register_rest_route().
add_action( 'rest_api_init', function () {
register_rest_route( 'myplugin/v1', '/check-boolean/', array(
'methods' => 'POST',
'callback' => 'myplugin_check_boolean',
));
});Шаг 2: Создание коллбэка для проверки булева значения
Далее, мы создадим коллбэк функцию myplugin_check_boolean, которая будет использовать rest_is_boolean() для проверки значения.
function myplugin_check_boolean( WP_REST_Request $request ) {
// Получение параметра is_active из запроса
$is_active = $request->get_param( 'is_active' );
// Проверка, является ли параметр булевым
if ( rest_is_boolean( $is_active ) ) {
return new WP_REST_Response( array(
'status' => 'success',
'message' => 'The value is a valid boolean.'
), 200 );
} else {
return new WP_REST_Response( array(
'status' => 'error',
'message' => 'The value is not a valid boolean.'
), 400 );
}
}Шаг 3: Тестирование API
Теперь мы можем протестировать наш новый REST API маршрут. Сделаем POST запрос к /wp-json/myplugin/v1/check-boolean/ с параметром is_active.
Пример запроса:
curl -X POST http://your-site.com/wp-json/myplugin/v1/check-boolean/ \
-d is_active=trueПример ответа для валидного булева значения:
{
"status": "success",
"message": "The value is a valid boolean."
}Пример запроса для невалидного значения:
curl -X POST http://your-site.com/wp-json/myplugin/v1/check-boolean/ \
-d is_active=notabooleanПример ответа для невалидного значения:
{
"status": "error",
"message": "The value is not a valid boolean."
}Заключение
Функция rest_is_boolean() в WordPress является простой, но полезной утилитой для проверки булевых значений, особенно при работе с REST API. Используя приведённые выше примеры, вы можете легко интегрировать её в свои собственные проекты, обеспечивая корректность передаваемых данных.