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

In this article

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

Changelog

VersionDescription
5.8.0Introduced.

User Contributed Notes

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