УРОК · WordPress: темы и плагины

REST API и производительность

Опубликовано Автор: Соловьёва Мария Андреевна

Заметка уже доступна как HTML. Добавим отдельный JSON-адрес для пяти последних публичных заметок и закрытый адрес с их общим числом.

Разберём по шагам

Маршрут REST API связывает HTTP-адрес с функцией, возвращающей данные. Для каждого собственного маршрута нужен permission_callback: публичный список явно разрешён, статистика требует manage_options. Список выбирает только опубликованные заметки и ограничен пятью элементами. Это измеримый предел размера ответа; время ответа зависит от машины и не доказывает ускорение. no_found_rows не просит базу считать все совпадения, когда пагинация не нужна.

Слова, которые пригодятся

REST-маршрут
HTTP-адрес, по которому WordPress отдаёт данные. Здесь /wp-json/fsl-lab/v1/notes возвращает массив заметок.
JSON
Текстовый формат данных с полями и списками, который удобно читать программой. В ответе каждая заметка имеет только id и title.
permission_callback
Функция WordPress, решающая, разрешён ли вызов маршрута текущему пользователю.
Граница выборки
Ограничение числа записей, которые сервер собирает для одного ответа. numberposts => 5 не даёт списку расти вместе со всей базой.

У публичного списка __return_true означает осознанный доступ всем. Для статистики manage_options проверяется на сервере; отдельный браузерный вход не даёт прав без передачи аутентификации в запросе.

Пять элементов — критерий ограниченного ответа, а не доказательство быстрого сайта. Чтобы искать реальное узкое место, отдельно измеряют запросы базы, нагрузку плагинов и время на целевом сервере.

Рабочий пример

// Добавьте ниже кода формы в fsl-lab-notes.php.
add_action('rest_api_init', function () {
    register_rest_route('fsl-lab/v1', '/notes', [
        'methods' => 'GET',
        'permission_callback' => '__return_true',
        'callback' => function () {
            $notes = get_posts([
                'post_type' => 'lab_note',
                'post_status' => 'publish',
                'numberposts' => 5,
                'no_found_rows' => true,
            ]);
            return array_map(fn ($note) => [
                'id' => $note->ID,
                'title' => get_the_title($note),
            ], $notes);
        },
    ]);
    register_rest_route('fsl-lab/v1', '/stats', [
        'methods' => 'GET',
        'permission_callback' => fn () => current_user_can('manage_options'),
        'callback' => fn () => ['published' => (int) wp_count_posts('lab_note')->publish],
    ]);
});

Практика

Получите ограниченный JSON-список и сравните его после роста данных. Затем проверьте, что закрытый маршрут требует право администратора.

  1. В Visual Studio Code откройте wp-content/plugins/fsl-lab-notes/fsl-lab-notes.php, добавьте пример в конец после обработчика формы, без нового <?php, сохраните и выполните php -l wp-content/plugins/fsl-lab-notes/fsl-lab-notes.php. Сервер wp server из второго урока должен работать.
  2. В браузере откройте http://127.0.0.1:8002/wp-json/fsl-lab/v1/notes или во втором терминале выполните curl -i http://127.0.0.1:8002/wp-json/fsl-lab/v1/notes. Ожидайте 200 и JSON-массив с id и title, без авторов и других полей. Для http://127.0.0.1:8002/wp-json/fsl-lab/v1/stats без входа curl -i должен показать 401 с rest_forbidden. Вход в браузере сам по себе не проверяет CLI-запрос: у curl нет браузерной сессии.
  3. Запишите число опубликованных заметок командой php ../wp-cli-2.12.0.phar post list --post_type=lab_note --post_status=publish --format=count. Добавьте ещё 20 одинаковых по длине названий, например командами for n in $(seq 1 20); do php ../wp-cli-2.12.0.phar post create --post_type=lab_note --post_status=publish --post_title="Тестовая заметка $n" --quiet; done. После этого выполните curl -sS -o /tmp/fsl-notes.json -w "status=%{http_code} bytes=%{size_download} time=%{time_total}\n" http://127.0.0.1:8002/wp-json/fsl-lab/v1/notes и php -r '$a=json_decode(file_get_contents("/tmp/fsl-notes.json"),true); echo count($a), PHP_EOL;': ожидайте 200 и ровно 5 элементов. Повторите после ещё 20 заметок; массив остаётся ограничен пятью, а байты зависят от длины названий и ID.
  4. Для закрытого маршрута выполните php ../wp-cli-2.12.0.phar eval 'wp_set_current_user(1); $r=rest_do_request(new WP_REST_Request("GET", "/fsl-lab/v1/stats")); echo $r->get_status(), " ", $r->get_data()["published"], PHP_EOL;' на новой учебной установке, где первый администратор имеет ID 1: ожидайте 200 и число опубликованных заметок. Эта проверка идёт внутри WordPress через WP-CLI, а не имитирует аутентификацию внешнего клиента.

Как проверить себя

Публичный ответ содержит не более пяти опубликованных заметок; гостевой запрос статистики получает 401, а проверка WP-CLI с правами администратора — 200 и число записей.

Если не получилось
  • 404 у /wp-json/...? Проверьте, что плагин активен, сервер открыт из корня учебной установки и php -l проходит. Затем выполните php ../wp-cli-2.12.0.phar rewrite flush.
  • В публичном JSON нет заметки? Проверьте, что у неё статус publish и она входит в пять последних; черновики намеренно скрыты.
  • В закрытом маршруте 401 даже после входа в браузере? curl не использует его cookie. Для учебной проверки прав используйте указанную команду wp eval.

Куда заглянуть дальше