WP_REST_Sidebars_Controller::get_sidebar() WordPress Method

The WP_REST_Sidebars_Controller::get_sidebar() method is used to retrieve a sidebar by its id.

WP_REST_Sidebars_Controller::get_sidebar( string|int $id ) #

Retrieves the registered sidebar with the given id.

Contents

Parameters

$id

(string|int)(Required)ID of the sidebar.

Top ↑

Return

(array|null) The discovered sidebar, or null if it is not registered.

Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php

	protected function get_sidebar( $id ) {
		return wp_get_sidebar( $id );
	}

Expand full source codeCollapse full source codeView on TracView on GitHub

Top ↑

Top ↑

Used By

Used By
Used ByDescription
wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php:WP_REST_Sidebars_Controller::get_items_permissions_check()

Checks if a given request has access to get sidebars.

wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php:WP_REST_Sidebars_Controller::get_items()

Retrieves the list of sidebars (active or inactive).

wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php:WP_REST_Sidebars_Controller::get_item_permissions_check()

Checks if a given request has access to get a single sidebar.

wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php:WP_REST_Sidebars_Controller::get_item()

Retrieves one sidebar from the collection.

wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php:WP_REST_Sidebars_Controller::update_item()

Updates a sidebar.

Top ↑

Changelog

Changelog
VersionDescription
5.8.0Introduced.
Download the latest version of WordPress from https://wordpress.org/

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.