WP_REST_Sidebars_Controller::get_item( WP_REST_Request $request ): WP_REST_Response|WP_Error

Parameters

$requestWP_REST_Request

Full details about the request.

Return

WP_REST_Response|WP_Error

Response object on success, or WP_Error object on failure.

Uses · 5

• __()Retrieves the translation of $text.
• WP_REST_Sidebars_Controller::retrieve_widgets()Looks for "lost" widgets once per request.
• WP_REST_Sidebars_Controller::get_sidebar()Retrieves the registered sidebar with the given id.
• WP_Error::__construct()Initializes the error.
• WP_REST_Sidebars_Controller::prepare_item_for_response()Prepares a single sidebar output for response.

Source

View on Trac ↗View on GitHub ↗

185	public function get_item( $request ) {186		$this->retrieve_widgets();187 188		$sidebar = $this->get_sidebar( $request['id'] );189		if ( ! $sidebar ) {190			return new WP_Error( 'rest_sidebar_not_found', __( 'No sidebar exists with that id.' ), array( 'status' => 404 ) );191		}192 193		return $this->prepare_item_for_response( $sidebar, $request );194	}

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 6.7.7 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.