Sidebars
These routes return registered theme sidebars and the widgets assigned to them.
Available routes (endpoints are described below):
/wp/v2/sidebars
/wp/v2/sidebars/{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. |
| name | view, edit |
Resource field. |
| description | view, edit |
Resource field. |
| status | view, edit |
Resource field. |
| widgets | view, edit |
Resource field. |
/wp/v2/sidebars
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/sidebars
Get data
Request type
GET /wp/v2/sidebars
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/sidebars