Типы виджетов (widget-types)

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

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

/wp/v2/widget-types
/wp/v2/widget-types/{id}
/wp/v2/widget-types/{id}/encode
/wp/v2/widget-types/{id}/render

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

• WP_REST_Widget_Types_Controller{}

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

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

Параметр	Контекст	Описание
id	view, edit	Поле ресурса.
name	view, edit	Поле ресурса.
description	view, edit	Поле ресурса.
is_multi	view, edit	Поле ресурса.
classname	view, edit	Поле ресурса.
widget_class	view, edit	Поле ресурса.

/wp/v2/widget-types

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

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

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

Вид запроса

GET /wp/v2/widget-types

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

$context(string)

Контекст ответа: view, embed или edit.

$page(integer)

Номер страницы коллекции.

$per_page(integer)

Число элементов на странице.

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

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

/wp/v2/widget-types/{id}

Получение типа виджета

Возвращает сведения об одном зарегистрированном типе виджета.

Вид запроса

GET /wp/v2/widget-types/{id}

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

$id(string) (обязательный)

Идентификатор типа виджета.

$context(string)

Контекст ответа: view, embed или edit.

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

$ curl https://example.com/wp-json/wp/v2/widget-types/{id}

/wp/v2/widget-types/{id}/encode

Кодирование настроек виджета

Преобразует сериализованные данные формы виджета в настройки его экземпляра.

Вид запроса

POST /wp/v2/widget-types/{id}/encode

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

$id(string) (обязательный)

Идентификатор типа виджета.

$instance(object)

Текущие настройки экземпляра виджета.

$form_data(string)

Сериализованные данные формы виджета.

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

$ curl -X POST https://example.com/wp-json/wp/v2/widget-types/{id}/encode -d 'form_data=...'

/wp/v2/widget-types/{id}/render

Рендеринг формы виджета

Возвращает HTML-разметку формы настроек экземпляра указанного типа виджета.

Вид запроса

POST /wp/v2/widget-types/{id}/render

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

$id(string) (обязательный)

Идентификатор типа виджета.

$instance(object)

Текущие настройки экземпляра виджета.

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

$ curl -X POST https://example.com/wp-json/wp/v2/widget-types/{id}/render