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

In this article

Gets an individual widget.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

Source

public function get_item( $request ) {
	$this->retrieve_widgets();

	$widget_id  = $request['id'];
	$sidebar_id = wp_find_widgets_sidebar( $widget_id );

	if ( is_null( $sidebar_id ) ) {
		return new WP_Error(
			'rest_widget_not_found',
			__( 'No widget was found with that id.' ),
			array( 'status' => 404 )
		);
	}

	return $this->prepare_item_for_response( compact( 'widget_id', 'sidebar_id' ), $request );
}

Changelog

VersionDescription
5.8.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.