WP_REST_Widget_Types_Controller::get_widget() – Method

WP_REST_Widget_Types_Controller::get_widget( string $id ): array|WP_Error

Gets the details about the requested widget.

Parameters

$idstringrequired: The widget type id.

Return

array|WP_Error The array of widget data if the name is valid, WP_Error otherwise.

Source

public function get_widget( $id ) {
	foreach ( $this->get_widgets() as $widget ) {
		if ( $id === $widget['id'] ) {
			return $widget;
		}
	}

	return new WP_Error( 'rest_widget_type_invalid', __( 'Invalid widget type.' ), array( 'status' => 404 ) );
}

View all references View on Trac View on GitHub

Uses	Description
WP_REST_Widget_Types_Controller::get_widgets()`wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php`	Normalize array of widgets.
WP_Error::__construct()`wp-includes/class-wp-error.php`	Initializes the error.

Used by	Description
WP_REST_Widget_Types_Controller::get_item()`wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php`	Retrieves a single widget type from the collection.
WP_REST_Widget_Types_Controller::get_item_permissions_check()`wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php`	Checks if a given request has access to read a widget type.

Changelog

Version	Description
5.8.0	Introduced.

User Contributed Notes

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