unregister_widget( string|WP_Widget $widget )

Unregisters a widget.

Description

Unregisters a WP_Widget widget. Useful for un-registering default widgets. Run within a function hooked to the ‘widgets_init’ action.

See also

Parameters

$widget

(string|WP_Widget) (Required) Either the name of a WP_Widget subclass or an instance of a WP_Widget subclass.

More Information

List of WP_Widget subclass names:

WP_Widget_Pages = Pages Widget
WP_Widget_Calendar = Calendar Widget
WP_Widget_Archives = Archives Widget
WP_Widget_Links = Links Widget
WP_Widget_Media_Audio = Audio Player Media Widget
WP_Widget_Media_Image = Image Media Widget
WP_Widget_Media_Video = Video Media Widget
WP_Widget_Media_Gallery = Gallery Media Widget
WP_Widget_Meta = Meta Widget
WP_Widget_Search = Search Widget
WP_Widget_Text = Text Widget
WP_Widget_Categories = Categories Widget
WP_Widget_Recent_Posts = Recent Posts Widget
WP_Widget_Recent_Comments = Recent Comments Widget
WP_Widget_RSS = RSS Widget
WP_Widget_Tag_Cloud = Tag Cloud Widget
WP_Nav_Menu_Widget = Menus Widget
WP_Widget_Custom_HTML = Custom HTML Widget

Source

File: wp-includes/widgets.php 

function unregister_widget( $widget ) {
	global $wp_widget_factory;

	$wp_widget_factory->unregister( $widget );
}

Changelog

Version Description
4.6.0 Updated the $widget parameter to also accept a WP_Widget instance object instead of simply a WP_Widget subclass name.
2.8.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/unregister_widget