Sidebars
Edit
Topics
Schema
The schema defines all the fields that exist within a sidebar record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id string |
ID of sidebar.
Read only Context: |
name string |
Unique name identifying the sidebar.
Read only Context: |
description string |
Description of sidebar.
Read only Context: |
class string |
Extra CSS class to assign to the sidebar in the Widgets interface.
Read only Context: |
before_widget string |
HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.
Read only Context: |
after_widget string |
HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.
Read only Context: |
before_title string |
HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.
Read only Context: |
after_title string |
HTML content to append to the sidebar title when displayed. Default is a closing h2 element.
Read only Context: |
status string |
Status of sidebar.
Read only Context: One of: |
widgets array |
Nested widgets.
Context: |
Retrieve a Sidebar
Definition & Example Request
GET /wp/v2/sidebars
Query this endpoint to retrieve a specific sidebar record.
$ curl https://example.com/wp-json/wp/v2/sidebars
Retrieve a Sidebar
Definition & Example Request
GET /wp/v2/sidebars/<id>
Query this endpoint to retrieve a specific sidebar record.
$ curl https://example.com/wp-json/wp/v2/sidebars/<id>