wp_list_widget_controls()
云策文档标注
概述
wp_list_widget_controls() 函数用于在管理界面的小工具配置屏幕中显示指定侧边栏的小工具及其设置。它通过添加过滤器动态处理侧边栏参数，并输出相关HTML内容。
关键要点
- 用途：在管理后台显示侧边栏的小工具和设置，主要用于小工具配置界面。
- 参数：$sidebar（必需，侧边栏ID）和 $sidebar_name（可选，侧边栏名称，默认为空）。
- 内部操作：使用 add_filter() 添加 dynamic_sidebar_params 过滤器，调用 wp_sidebar_description() 获取侧边栏描述，并输出包含小工具列表的HTML。
- 相关函数：涉及 dynamic_sidebar()、wp_sidebar_description()、__()、esc_attr()、esc_html() 和 add_filter() 等。
- 版本历史：自 WordPress 2.5.0 版本引入。
代码示例
function wp_list_widget_controls( $sidebar, $sidebar_name = '' ) {
add_filter( 'dynamic_sidebar_params', 'wp_list_widget_controls_dynamic_sidebar' );
$description = wp_sidebar_description( $sidebar );
echo '';
if ( $sidebar_name ) {
$add_to = sprintf(
/* translators: %s: Widgets sidebar name. */
__( 'Add to: %s' ),
$sidebar_name
);
?>
">
';
}
原文内容
Show the widgets and their settings for a sidebar.
Description
Used in the admin widget config screen.
Parameters
$sidebarstringrequired- Sidebar ID.
$sidebar_namestringoptional- Sidebar name. Default empty.
Source
function wp_list_widget_controls( $sidebar, $sidebar_name = '' ) {
add_filter( 'dynamic_sidebar_params', 'wp_list_widget_controls_dynamic_sidebar' );
$description = wp_sidebar_description( $sidebar );
echo '<div id="' . esc_attr( $sidebar ) . '" class="widgets-sortables">';
if ( $sidebar_name ) {
$add_to = sprintf(
/* translators: %s: Widgets sidebar name. */
__( 'Add to: %s' ),
$sidebar_name
);
?>
<div class="sidebar-name" data-add-to="<?php echo esc_attr( $add_to ); ?>">
<button type="button" class="handlediv hide-if-no-js" aria-expanded="true">
<span class="screen-reader-text"></span>
<span class="toggle-indicator" aria-hidden="true"></span>
</button>
<h2> <span class="spinner"></span></h2>
</div>
<div class="sidebar-description">
<p class="description"></p>
</div>
';
}
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.