WP REST API Sidebars

January 14, 2016

WP REST API Sidebars Plugin

An extension for the WP REST API that exposes endpoints for sidebars and widgets.

An extension for the WP REST API that exposes endpoints for sidebars and widgets.

note: this plugin is under heavy development and will receive frequent feature updates (including documentation) so stay tuned and checkout the github repo for the latest updates

Currently supported endpoints

/wp-json/wp-rest-api-sidebars/v1/sidebarsreturns a list of registered sidebars

[ { "name": "Sidebar Name", "id": "sidebar-id", "description": "Sidebar description...", "class": "sidebar-class", "before_widget": "<aside id=\"%1$s\" class=\"widget %2$s\">", "after_widget": "<\/aside>", "before_title": "<h1 class=\"widget-title\">", "after_title": "<\/h1>" } ] 

/wp-json/wp-rest-api-sidebars/v1/sidebars/{id}returns the given sidebar

{ "name": "Sidebar Name", "id": "sidebar-id", "description": "Sidebar description...", "class": "sidebar-class", "before_widget": "<aside id=\"%1$s\" class=\"widget %2$s\">", "after_widget": "<\/aside>", "before_title": "<h1 class=\"widget-title\">", "after_title": "<\/h1>", "rendered": "<aside id=\"widget-id-1\" class=\"widget widget_widget-id\">...", "widgets": [ { "name": "Widget Name", "id": "widget-name-1", "classname": "widget_widget_name", "description": "Widget description", "rendered": "<aside id=\"widget-names-1\" class=\"widget widget_widget_name\">..." } ] } 

Installation

Get the content to the plugin directory and activate the plugin

note: to enable you to use any version/branch of the WP REST API plugin during this rapid development phase there is currently no good way to check if it is active. Therefore make sure that it is before you activate this plugin.

Changelog

0.1.1

  • Now using a plugin specific endpoint namespace: /wp-rest-api-sidebars/v1
  • Including widgets in the /sidebars/{id} response

Details

  • Version: 0.1.1
  • Active installations: 100
  • WordPress Version: 4.4
  • Tested up to: 4.4.33

Ratings


5 Stars
4 Stars
3 Stars
2 Stars
1 Stars