WP_REST_Sidebars_Controller::get_item( WP_REST_Request $request )

Retrieves one sidebar from the collection.

Parameters

$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 

	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 );
	}

Expand Source Code View on GitHub

Related

Uses

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

Looks for “lost” widgets once per request.
wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php: WP_REST_Sidebars_Controller::get_sidebar()

Retrieves the registered sidebar with the given id.
wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php: WP_REST_Sidebars_Controller::prepare_item_for_response()

Prepares a single sidebar output for response.

Changelog

Changelog
Version Description
5.8.0 Introduced.