Widgets
These routes let you retrieve, create, update, and delete widget instances in theme sidebars.
Available routes (endpoints are described below):
/wp/v2/widgets
/wp/v2/widgets/{id}
Controller classes:
Contents:
Resource schema
The schema lists fields returned by the resource. Fields depend on the context and user capabilities.
| Field | Context | Description |
|---|---|---|
| id | view, edit |
Resource field. |
| id_base | view, edit |
Resource field. |
| sidebar | view, edit |
Resource field. |
| rendered_form | view, edit |
Resource field. |
| instance | view, edit |
Resource field. |
| form | view, edit |
Resource field. |
| name | view, edit |
Resource field. |
/wp/v2/widgets
An OPTIONS request returns methods, parameters, and the complete schema for the selected route.
$ curl -X OPTIONS -i https://example.com/wp-json/wp/v2/widgets
Get data
Request type
GET /wp/v2/widgets
Request parameters
- $context(string)
- Response context:
view,embed, oredit. - $page(integer)
- Collection page number.
- $per_page(integer)
- Number of items per page.
Request example
$ curl https://example.com/wp-json/wp/v2/widgets
Create, update, and delete
Request type
POST /wp/v2/widgets
POST /wp/v2/widgets/{id}
DELETE /wp/v2/widgets/{id}
Request parameters
- $id(string)
- Resource field value.
- $id_base(string)
- Resource field value.
- $sidebar(string)
- Resource field value.
- $rendered_form(string)
- Resource field value.
Request example
$ curl -X POST https://example.com/wp-json/wp/v2/widgets -d status=publish