Виджеты (widgets)

Эти маршруты позволяют получать, создавать, изменять и удалять экземпляры виджетов в областях темы.

Возможные маршруты (конечные точки описаны ниже):

/wp/v2/widgets
/wp/v2/widgets/{id}

Классы контроллеров:

Схема ресурса

Схема показывает поля, которые возвращает ресурс. Набор полей зависит от контекста и прав пользователя.

Параметр Контекст Описание
id view, edit Поле ресурса.
id_base view, edit Поле ресурса.
sidebar view, edit Поле ресурса.
rendered_form view, edit Поле ресурса.
instance view, edit Поле ресурса.
form view, edit Поле ресурса.
name view, edit Поле ресурса.

/wp/v2/widgets

Запрос OPTIONS возвращает методы, параметры и полную схему выбранного маршрута.

$ curl -X OPTIONS -i https://example.com/wp-json/wp/v2/widgets

Получение данных

Вид запроса

GET /wp/v2/widgets

Параметры запроса

$context(string)
Контекст ответа: view, embed или edit.
$page(integer)
Номер страницы коллекции.
$per_page(integer)
Число элементов на странице.

Пример запроса

$ curl https://example.com/wp-json/wp/v2/widgets

Создание, изменение и удаление

Вид запроса

POST /wp/v2/widgets
POST /wp/v2/widgets/{id}
DELETE /wp/v2/widgets/{id}

Параметры запроса

$id(string)
Значение поля ресурса.
$id_base(string)
Значение поля ресурса.
$sidebar(string)
Значение поля ресурса.
$rendered_form(string)
Значение поля ресурса.

Пример запроса

$ curl -X POST https://example.com/wp-json/wp/v2/widgets -d status=publish