{"id":147369,"date":"2023-04-26T10:55:33","date_gmt":"2023-04-26T10:55:33","guid":{"rendered":"https:\/\/developer.wordpress.org\/rest-api\/reference\/sidebars\/"},"modified":"2024-01-16T20:30:12","modified_gmt":"2024-01-16T20:30:12","slug":"sidebars","status":"publish","type":"rest-api-handbook","link":"https:\/\/developer.wordpress.org\/rest-api\/reference\/sidebars\/","title":{"rendered":"Sidebars"},"content":{"rendered":"
\n
\n

Schema<\/h2>\n

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.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
\n id<\/code>\n <\/td>\n\n ID of sidebar.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: embed<\/code>, view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n name<\/code>\n <\/td>\n\n Unique name identifying the sidebar.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: embed<\/code>, view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n description<\/code>\n <\/td>\n\n Description of sidebar.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: embed<\/code>, view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n class<\/code>\n <\/td>\n\n Extra CSS class to assign to the sidebar in the Widgets interface.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: embed<\/code>, view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n before_widget<\/code>\n <\/td>\n\n HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: embed<\/code>, view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n after_widget<\/code>\n <\/td>\n\n HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: embed<\/code>, view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n before_title<\/code>\n <\/td>\n\n HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: embed<\/code>, view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n after_title<\/code>\n <\/td>\n\n HTML content to append to the sidebar title when displayed. Default is a closing h2 element.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: embed<\/code>, view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n status<\/code>\n <\/td>\n\n Status of sidebar.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: embed<\/code>, view<\/code>, edit<\/code><\/p>\n

One of: active<\/code>, inactive<\/code>\n <\/td>\n<\/tr>\n

\n widgets<\/code>\n <\/td>\n\n Nested widgets.<\/p>\n

\n JSON data type: array <\/p>\n

Context: embed<\/code>, view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n<\/table><\/div>\n<\/section>\n

\n
\n
\n

Retrieve a Sidebar<\/h2>\n

Definition & Example Request<\/h3>\n

GET \/wp\/v2\/sidebars<\/code><\/p>\n

Query this endpoint to retrieve a specific sidebar record.<\/p>\n

$ curl https:\/\/example.com\/wp-json\/wp\/v2\/sidebars<\/code>\n <\/div>\n

\n

Arguments<\/h3>\n\n\n
\n context<\/code>\n <\/td>\n\n Scope under which the request is made; determines fields present in response.<\/p>\n

\n Default: view<\/code>\n <\/p>\n

One of: view<\/code>, embed<\/code>, edit<\/code>\n <\/td>\n<\/tr>\n<\/table><\/div>\n<\/section>\n

\n
\n

Retrieve a Sidebar<\/h2>\n

Definition & Example Request<\/h3>\n

GET \/wp\/v2\/sidebars\/<id><\/code><\/p>\n

Query this endpoint to retrieve a specific sidebar record.<\/p>\n

$ curl https:\/\/example.com\/wp-json\/wp\/v2\/sidebars\/<id><\/code>\n <\/div>\n

\n

Arguments<\/h3>\n\n\n\n
\n id<\/code>\n <\/td>\n\n The id of a registered sidebar\n <\/td>\n<\/tr>\n
\n context<\/code>\n <\/td>\n\n Scope under which the request is made; determines fields present in response.<\/p>\n

\n Default: view<\/code>\n <\/p>\n

One of: view<\/code>, embed<\/code>, edit<\/code>\n <\/td>\n<\/tr>\n<\/table><\/div>\n<\/section>\n

\n
\n

Update a Sidebar<\/h2>\n

Arguments<\/h3>\n\n\n
\n widgets<\/a><\/code>\n <\/td>\n\n Nested widgets.\n <\/td>\n<\/tr>\n<\/table><\/div>\n
\n

Definition<\/h3>\n

POST \/wp\/v2\/sidebars\/<id><\/code><\/p>\n

Example Request<\/h3>\n

<\/code>\n <\/div>\n<\/section>\n<\/div>\n","protected":false},"author":0,"featured_media":0,"parent":23078,"menu_order":0,"template":"","meta":{"_crdt_document":"","footnotes":""},"class_list":["post-147369","rest-api-handbook","type-rest-api-handbook","status-publish","hentry","type-handbook"],"revision_note":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/147369","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook"}],"about":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/types\/rest-api-handbook"}],"version-history":[{"count":3,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/147369\/revisions"}],"predecessor-version":[{"id":151975,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/147369\/revisions\/151975"}],"up":[{"embeddable":true,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23078"}],"wp:attachment":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/media?parent=147369"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}