WordPress Создать пользовательскую конечную точку REST

Опубликовано: 23 Февраля, 2023

В этой статье мы увидим, как создать пользовательскую конечную точку REST в WordPress. WordPress используется не только для ведения блогов и простой платформы для сайтов. Теперь он используется для крупномасштабных корпоративных проектов и даже безголовой CMS. Поэтому, если вы используете WordPress в качестве безголовой CMS, вы должны знать, как работать с REST API.

WordPress предоставляет различные функции для работы с REST API. Давайте посмотрим, как можно легко создать пользовательскую конечную точку.

Мы будем использовать хук действия rest_api_init и встроенную функцию register_rest_route() для создания нашей пользовательской конечной точки.

Шаги по созданию пользовательской конечной точки REST: вам нужно добавить этот код в файл functions.php темы.

Шаг 1: Создайте функцию, которая регистрирует REST-маршрут с помощью функции register_rest_route() .

PHP




<?php
function create_custon_endpoint(){
    register_rest_route(
        "wp/v2",
        "/custom-ep",
        array(
            "methods" => "GET",
            "callback" => "get_response",
        )
    );
}
?>

Первый параметр этой функции — это пространство имен «wp/v2», второй параметр — это имя конечной точки «/custom-ep», а третий параметр — это массив, в который вы можете добавлять такие методы, как GET , POST , DELETE и т. д., и функцию обратного вызова. . Вы можете настроить эти значения в соответствии с вашими потребностями.

Для получения более подробной информации вы можете проверить документ.

Шаг 2: Создайте функцию обратного вызова get_response().

PHP




<?php
function get_response() {
    // Your code...
    return "This is your data!";
}
?>

В этой функции вы можете делать все, что хотите добавить к своей конечной точке.

Шаг 3: Добавьте хук действия rest_api_init , который будет запускать нашу функцию create_custon_endpoint при инициализации REST API в WordPress.

PHP




<?php
add_action( "rest_api_init", "create_custon_endpoint");
?>

Полный код: ниже приведены все шаги в одном кадре.

Выход: