函数文档

register_widget()

💡 云策文档标注

概述

register_widget() 函数用于注册一个 WP_Widget 小部件,是 WordPress 小部件系统的基础功能。

关键要点

  • 注册一个 WP_Widget 子类或实例,使其可用于小部件管理界面。
  • 参数 $widget 可以是 WP_Widget 子类名称或实例对象,自 4.6.0 版本起支持实例对象。
  • 内部调用 WP_Widget_Factory::register() 方法实现注册。
  • 在 wp_widgets_init() 中用于注册默认小部件。

代码示例

function register_widget( $widget ) {
	global $wp_widget_factory;

	$wp_widget_factory->register( $widget );
}

注意事项

  • 确保 $widget 参数是有效的 WP_Widget 子类名称或实例,否则可能导致错误。
  • 注册小部件通常在主题或插件的初始化钩子中执行,如 widgets_init。

📄 原文内容

Registers a widget.

Description

Registers a WP_Widget widget

See also

Parameters

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

Source

function register_widget( $widget ) {
	global $wp_widget_factory;

	$wp_widget_factory->register( $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.

User Contributed Notes