wp_set_sidebars_widgets()
云策文档标注
概述
wp_set_sidebars_widgets() 函数用于设置侧边栏小部件选项,以更新侧边栏配置。它通过更新 'sidebars_widgets' 选项来管理小部件在侧边栏中的布局和设置。
关键要点
- 函数接受一个必需参数 $sidebars_widgets,类型为数组,包含侧边栏小部件及其设置。
- 内部操作包括清除 wp_get_sidebars_widgets() 使用的缓存值,并确保数组版本设置为 3。
- 核心功能是调用 update_option() 来持久化侧边栏小部件数据到数据库。
- 该函数在多个相关函数中使用,如 WP_REST_Sidebars_Controller::update_item() 和 wp_assign_widget_to_sidebar(),用于处理侧边栏和小部件的更新、分配和保存。
代码示例
function wp_set_sidebars_widgets( $sidebars_widgets ) {
global $_wp_sidebars_widgets;
// Clear cached value used in wp_get_sidebars_widgets().
$_wp_sidebars_widgets = null;
if ( ! isset( $sidebars_widgets['array_version'] ) ) {
$sidebars_widgets['array_version'] = 3;
}
update_option( 'sidebars_widgets', $sidebars_widgets );
}
原文内容
Sets the sidebar widget option to update sidebars.
Parameters
$sidebars_widgetsarrayrequired-
Sidebar widgets and their settings.
Source
function wp_set_sidebars_widgets( $sidebars_widgets ) {
global $_wp_sidebars_widgets;
// Clear cached value used in wp_get_sidebars_widgets().
$_wp_sidebars_widgets = null;
if ( ! isset( $sidebars_widgets['array_version'] ) ) {
$sidebars_widgets['array_version'] = 3;
}
update_option( 'sidebars_widgets', $sidebars_widgets );
}
Changelog
| Version | Description |
|---|---|
| 2.2.0 | Introduced. |