WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Widget_Factory::get_widget_object()

WP_Widget_Factory::get_widget_object( string $id_base ): WP_Widget|null

In this article

Back to top

Returns the registered WP_Widget object for the given widget type.

Parameters

$id_basestringrequired
Widget type ID.

Return

WP_Widget|null

Source

public function get_widget_object( $id_base ) {
	$key = $this->get_widget_key( $id_base );
	if ( '' === $key ) {
		return null;
	}

	return $this->widgets[ $key ];
}

View all references View on Trac View on GitHub

UsesDescription
WP_Widget_Factory::get_widget_key()wp-includes/class-wp-widget-factory.php

Returns the registered key for the given widget type.

Used byDescription
WP_REST_Widgets_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Prepares the widget for the REST response.

WP_REST_Widgets_Controller::update_item()wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Updates an existing widget.

WP_REST_Widgets_Controller::delete_item()wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Deletes a widget.

WP_REST_Widgets_Controller::save_widget()wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Saves the widget in the request object.

WP_REST_Widget_Types_Controller::get_widgets()wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php

Normalize array of widgets.

WP_REST_Widget_Types_Controller::encode_form_data()wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php

An RPC-style endpoint which can be used by clients to turn user input in a widget admin form into an encoded instance object.

WP_Customize_Widgets::sanitize_widget_instance()wp-includes/class-wp-customize-widgets.php

Sanitizes a widget instance.

WP_Customize_Widgets::sanitize_widget_js_instance()wp-includes/class-wp-customize-widgets.php

Converts a widget instance into JSON-representable format.

Show 3 moreShow less

Changelog

VersionDescription
5.8.0Introduced.

User Contributed Notes

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