WP REST API Sidebars

from 0$

WP REST API Sidebars is a WP Plugin Package from the Open Source WP Plugins range An extension for the WP REST API that exposes endpoints for sidebars and widgets.


For more information about a tailored WP Plugin Package like WP REST API Sidebars please contact us directly.

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/sidebars returns 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">..."
        }
    ]
}

Download & install the zip archive

The plugin package installer can be downloaded from the WP2E project tab called “code”.

1 – Select the version to download if this option is available otherwise the “latest” version of the main plugin will be used.

2 – After downloading the zip archive install the plugin package installer in you local environment and activate the script from the plugin list.

3 – Under the section “Plugins” of the admin dashboard you should see a new “Dependencies & Licenses” link. Follow the instructions from this panel to finalize the installation of the missing dependencies.

Tips: Use the WP2E panel to add/suggest new dependencies to the local installation. Press F5 in the list of dependencies if the changes are not displayed right away.

WP REST API Sidebars

typePlugin
version0.1.1
descriptionAn extension for the WP REST API that exposes endpoints for sidebars and widgets.