On this page
WP_REST_Sidebars_Controller::get_item( WP_REST_Request $request ): WP_REST_Response|WP_Error
Retrieves one sidebar from the collection.
Parameters
$requestWP_REST_Request Required-
Full details about the request.
Return
WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php. View all references
public function get_item( $request ) {
$this->retrieve_widgets();
$sidebar = $this->get_sidebar( $request['id'] );
if ( ! $sidebar ) {
return new WP_Error( 'rest_sidebar_not_found', __( 'No sidebar exists with that id.' ), array( 'status' => 404 ) );
}
return $this->prepare_item_for_response( $sidebar, $request );
}
Related
Uses
| Uses | Description |
|---|---|
| WP_REST_Sidebars_Controller::retrieve_widgets() wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php | Looks for “lost” widgets once per request. |
| WP_REST_Sidebars_Controller::get_sidebar() wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php | Retrieves the registered sidebar with the given id. |
| WP_REST_Sidebars_Controller::prepare_item_for_response() wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php | Prepares a single sidebar output for response. |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| WP_Error::__construct() wp-includes/class-wp-error.php | Initializes the error. |
Changelog
| Version | Description |
|---|---|
| 5.8.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_sidebars_controller/get_item