unregister_widget()

💡 云策文档标注

概述

unregister_widget() 函数用于注销一个 WP_Widget 小部件，常用于移除默认小部件。必须在 'widgets_init' 钩子中调用。

关键要点

注销 WP_Widget 小部件，支持传入小部件类名或实例对象
参数 $widget 为必需，可以是 WP_Widget 子类名称字符串或 WP_Widget 实例
必须在 'widgets_init' 动作钩子中运行以确保正确时机
从 WordPress 4.6.0 开始，$widget 参数也接受 WP_Widget 实例对象

代码示例

function wpdocs_remove_calendar_widget() {
    unregister_widget( 'WP_Widget_Calendar' );
}
add_action( 'widgets_init', 'wpdocs_remove_calendar_widget' );

注意事项

参考 WP_Widget_Factory::unregister() 方法实现注销逻辑
常见 WP_Widget 子类包括 WP_Widget_Pages、WP_Widget_Calendar 等，列表已提供

📄 原文内容

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.

Parameters

$widgetstring|WP_Widgetrequired: Either the name of a WP_Widget subclass or an instance of a WP_Widget subclass.

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

function unregister_widget( $widget ) {
	global $wp_widget_factory;

	$wp_widget_factory->unregister( $widget );
}

View all references View on Trac View on GitHub

Uses	Description
WP_Widget_Factory::unregister()`wp-includes/class-wp-widget-factory.php`	Un-registers a widget subclass.

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.

User Contributed Notes

Skip to note 2 content

Codex

10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Example

This will un-register the built-in WP_Widget_Calendar widget (useful if you wish to replace the built-in version).
```
function wpdocs_remove_calendar_widget() {
	unregister_widget( 'WP_Widget_Calendar' );
}
add_action( 'widgets_init', 'wpdocs_remove_calendar_widget' );
```
Log in to add feedback

云策 WordPress 开发者社区

函数文档