Вопрос или проблема
Я создаю веб-сервис, используя WP REST API v.2.
Можно ли включить что-то вроде фильтра meta_query при запросе пользовательского типа записи?
Например, если бы я использовал WP_Query, я мог бы сделать это так:
$args = array(
'post_type' => 'proposal',
'posts_per_page' => -1,
'meta_query' => array(
array(
'key' => 'deadline',
'value' => current_time( 'm/d/Y' ),
'compare' => '>=',
)
)
);
$proposals_query = new WP_Query( $args );
Можно ли достичь того же самого в REST-запросе?
Примерная цель — сообщить сервису, что клиент хочет получить ответ, который включает только записи, соответствующие условиям meta_query.
Я думаю, что мог бы отправить переменную в запросе и использовать ее для создания meta_query в пользовательской конечной точке…? Так что интересно, существует ли какой-либо рекомендуемый способ для этого.
Возможно, это не совсем тот ответ, который вы ищете, но вот он….
REST API, как он реализован в ядре WordPress, — это насмешка над тем, как API должны быть разработаны, и чем меньше вы его используете, тем лучше. Очевидно, что глупо не использовать ядровое API, которое делает то, что вам нужно, но для всего остального вам следует просто написать свои собственные API.
REST API разработан как удаленный вызов для выполнения внутренних API, вместо того чтобы выполнять очень специфическое действие. Это приводит к двум большим проблемам:
-
Утечка информации. API возвращает гораздо больше, чем вам нужно, и часть информации, которую он возвращает, не должна возвращаться из соображений конфиденциальности и безопасности. Если я знаю ID автора, вашу версию WP и используемые плагины, я могу попытаться атаковать ваш сайт.
-
Неоптимальная структура данных, которая может привести к необходимости выполнения двух запросов к базе данных на стороне сервера, вынуждает вас делать два HTTP-запроса, что занимает гораздо больше времени и увеличивает нагрузку на сервер. Один из примеров (я надеюсь, что они это исправили) — необходимость дополнительного запроса, чтобы получить миниатюру записи, потому что она не относится к структуре БД записи, а относится к структуре вложения.
Ваш вопрос намекает на дальнейшее усугубление проблем: пользователи не только узнают, какой тип записи вы используете, но и какие метаданные имеются и в каком формате они находятся.
Что вы должны сделать, это написать свою собственную конечную точку и свой собственный API, который будет принимать только то, что ему нужно, и возвращать то, что пользователь действительно требует.
И кстати, никогда не позволяйте кому-либо запрашивать все ваши записи, это просто приглашение к легкой DOS-атаки на сайт.
Ответ или решение
Создание веб-сервиса с использованием WP REST API v.2 и необходимость использования meta_query для фильтрации данных может быть вызовом, особенно если вам необходима точная фильтрация, аналогичная той, которая возможна с WP_Query. Рассмотрим, как можно достичь аналогичного результата, рассматривая при этом наиболее оптимальный и безопасный подход.
Фильтрация с использованием WP REST API
К сожалению, WP REST API из коробки не поддерживает фильтрацию через meta_query столь гибко, как WP_Query. Однако вы можете расширить функциональность REST API, добавив собственную логику в обработчик запроса.
Настройка кастомного эндпоинта
-
Регистрация кастомного эндпоинта:
Создадим новый эндпоинт, который будет принимать параметры, необходимые для фильтрации по мета-полям. Это делается через хук
register_rest_route.add_action('rest_api_init', function () { register_rest_route('custom/v1', '/proposals/', array( 'methods' => 'GET', 'callback' => 'get_filtered_proposals', )); }); -
Создание обработчика:
Функция, используемая в качестве обратного вызова, должна формировать
WP_Queryс нужными аргументами.function get_filtered_proposals($request) { $args = array( 'post_type' => 'proposal', 'posts_per_page' => -1, 'meta_query' => array( array( 'key' => 'deadline', 'value' => current_time('m/d/Y'), 'compare' => '>=', ) ) ); $query = new WP_Query($args); $posts = array(); if ($query->have_posts()) { while ($query->have_posts()) { $query->the_post(); $posts[] = array( 'id' => get_the_ID(), 'title' => get_the_title(), 'content' => get_the_content(), // добавьте другие необходимые поля ); } wp_reset_postdata(); } return rest_ensure_response($posts); } -
Проблемы безопасности и производительности:
Избегайте раскрытия чувствительных данных: создавайте API так, чтобы он принимал только необходимые параметры и возвращал только те данные, которые запрашиваются.
Выводы
Создание кастомного эндпоинта может потребовать времени, но в конечном итоге обеспечивает гибкость и безопасность, отсутствующую при использовании стандартного WP REST API. Вы получаете контроль над тем, какие параметры принимает и какие данные возвращает ваш API, избегая при этом потенциальных уязвимостей и проблем с производительностью.
Увеличение SEO
Использование ключевых фраз, таких как "кастомный эндпоинт WP REST API", "WP_Query альтернатива", и "мета-фильтрация данных" в заголовках и тексте статьи помогут улучшить видимость вашего контента для тех, кто ищет подобные решения.
Такие стратегии позволят достичь максимальной эффективности при разработке веб-сервисов с использованием WordPress и при этом соблюсти высокие стандарты безопасности и производительности.