unregister_sidebar_widget()
云策文档标注
概述
unregister_sidebar_widget() 是 wp_unregister_sidebar_widget() 的别名函数,用于从侧边栏移除小部件。自 WordPress 2.8.0 起已弃用,建议开发者直接使用 wp_unregister_sidebar_widget()。
关键要点
- 此函数是 wp_unregister_sidebar_widget() 的别名,功能相同,用于注销侧边栏小部件。
- 自 WordPress 2.8.0 版本起被标记为弃用,调用时会触发 _deprecated_function() 警告。
- 参数 $id 为必需,类型为 int 或 string,表示要移除的小部件 ID。
- 函数定义在 wp-includes/widgets.php 中,相关函数包括 wp_unregister_sidebar_widget() 和 _deprecated_function()。
代码示例
function unregister_sidebar_widget($id) {
_deprecated_function( __FUNCTION__, '2.8.0', 'wp_unregister_sidebar_widget()' );
return wp_unregister_sidebar_widget($id);
}注意事项
- 在开发新代码时,应避免使用此弃用函数,改用 wp_unregister_sidebar_widget() 以确保兼容性和最佳实践。
- 调用此函数可能会在调试模式下输出弃用警告,影响性能或日志记录。
原文内容
Serves as an alias of wp_unregister_sidebar_widget() .
Description
See also
Parameters
$idint|stringrequired-
Widget ID.
Source
function unregister_sidebar_widget($id) {
_deprecated_function( __FUNCTION__, '2.8.0', 'wp_unregister_sidebar_widget()' );
return wp_unregister_sidebar_widget($id);
}
Changelog
| Version | Description |
|---|---|
| 2.8.0 | Deprecated. Use wp_unregister_sidebar_widget() |
| 2.2.0 | Introduced. |