WordPress 函数：register_sidebar()创建主题侧边栏

我们制作的wordpress主题默认是不支持WordPress后台 – 外观 – 小工具的，需要手动在functions.php里注册我们的边栏小工具。

Table of Contents

1、用法：

使用函数register_sidebar()注册一个单独的侧边栏区域和返回ID，供 “widgets_init” 钩子调用。

register_sidebar( $args );

2、参数

$args
（字符串 | 数组）（可选）创建基于“name”和“id”的侧边栏。
默认值： None

$args = array(

    'name'          => __( 'Sidebar name', 'theme_text_domain' ),

    'id'            => 'unique-sidebar-id',

    'description'   => '',

    'class'         => '',

    'before_widget' => '<li id="%1" class="widget %2">',

    'after_widget'  => '</li>',

    'before_title'  => '<h2 class="widgettitle">',

    'after_title'   => '</h2>'

);

3、数组参数介绍：

args 参数是一个关联数组，它将会传递到每个一个小工具回调函数作为第一个参数（如果传递的是一个字符串，它将被传递到 parse_str() 生成一个关联数组）。这些参数的基本用途就是传递主题特有的 HTML 标签来包裹小工具和标题。
（1）name：侧边栏的名字（默认是 ‘Sidebar’ 加数字 ID）
（2）id：侧边栏 ID，必须全部小写，不带空格（默认是一个自动递增的数字 ID）
（3）description：用来说明侧边栏是什么，在哪里显示的文字，会在小工具管理界面显示。（默认为空）
（4）class：分配到小工具 HTML输出中的CSS选择器名字（默认为空）
（5）before_widget：里边的小工具的开头 Html 代码
（6）after_widget：里边的小工具的末尾的 Html 代码
（7） before_title：里边的小工具的标题的开头 Html 代码
（8）after_title：里边的小工具的标题的末尾的 Html 代码）

4、注释

WordPress 3.4.1 以后你要避免使用 WP保留的 ID。
重复多次使用 register_sidebar() 注册多个侧边栏的话，建议使用 gister_sidebars() 一次性注册多个，因为它允许你分配一个单一无二的名字到每个侧边栏（例如：“左边栏”“右边栏”）。虽然这些名字只出现在管理界面中，但是最好的做法是具体命名每一个侧边栏，提醒管理用户每个侧边栏的用途。
before/after 的默认值是用于让主题生成以 h2 标题标记的侧边栏小工具。主要是为了让创建侧边栏时更加简单，不必担心 before/after 标签。但是如果你不限使用默认的值，你必须在注册侧边栏时指定这些标签。建议逐字复制 ID 和 class 属性，确保内部的 sprintf 调用可以正常工作于单独的小工具。

5、使用示例

register_sidebar(array(

		'name' => 'First_sidebar',

		'id'           => 'sidebar-1',

                'description'  => __( '右侧边栏的小工具。' ),

		'before_widget' => '',

		'after_widget' => '',

		'before_title' => '<h4>',

		'after_title' => '</h4>'

));

6、函数历史

开始于 2.2.0 版本，2.9.0 添加 description 属性，WordPress 3.4.1 以后你要避免使用 WP保留的 ID，必须手动为你的小工具添加ID.

7、其它

该函数位于：wp-includes/widgets.php

WordPress官方函数阅读：http://codex.wordpress.org/Function_Reference/register_sidebar