WP_REST_Widgets_Controller::get_item() WordPress Method
The WP_REST_Widgets_Controller::get_item() method is used to get a single widget instance. This method accepts a single argument, the widget ID. It returns a WP_REST_Response object containing the widget data.
WP_REST_Widgets_Controller::get_item( WP_REST_Request $request ) #
Gets an individual widget.
Parameters
- $request
(WP_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-widgets-controller.php
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 ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.8.0 | Introduced. |