WP_REST_Sidebars_Controller::get_sidebar( string|int $id ): array|null

Parameters

$idstring|int

ID of the sidebar.

Return

array|null

The discovered sidebar, or null if it is not registered.

Uses · 1

• wp_get_sidebar()Retrieves the registered sidebar with the given ID.

Used by · 5

• WP_REST_Sidebars_Controller::get_item()Retrieves one sidebar from the collection.
• WP_REST_Sidebars_Controller::get_item_permissions_check()Checks if a given request has access to get a single sidebar.
• WP_REST_Sidebars_Controller::get_items()Retrieves the list of sidebars (active or inactive).
• WP_REST_Sidebars_Controller::get_items_permissions_check()Checks if a given request has access to get sidebars.
• WP_REST_Sidebars_Controller::update_item()Updates a sidebar.

Source

View on Trac ↗View on GitHub ↗

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

History

Introduced in 5.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.