Codex

Function Reference/register sidebars

Contents

Description

Creates multiple sidebars.

Registers one or more sidebars to be used in the current theme. Most themes have only one sidebar. For this reason, the number parameter is optional and defaults to one.

The args array parameter can contain a 'name' which will be prepended to the sidebar number if there is more than one sidebar. If no name is specified, 'Sidebar' is used.

Usage

 <?php register_sidebars( $number, $args ); ?> 

Default Usage

 <?php $args = array(
    'name'          => sprintf(__('Sidebar %d'), $i ),
    'id'            => 'sidebar-$i',
    'before_widget' => '<li id=\"%1$s\" class=\"widget %2$s\">',
    'after_widget'  => '</li>',
    'before_title'  => '<h2 class=\"widgettitle\">',
    'after_title'   => '</h2>' ); ?> 

Parameters

$number
(int) (required) Number of sidebars to create.
Default: None
$args
(string/array) (optional) Builds Sidebar based off of 'name' and 'id' values.
Default: None
  • name - Sidebar name.
  • id - Sidebar id.
  • before_widget - Text to place before every widget.
  • after_widget - Text to place after every widget.
  • before_title - Text to place before every title.
  • after_title - Text to place after every title.

The optional $args parameter is an associative array that will be passed as a first argument to every active widget callback. (If a string is passed instead of an array, it will be passed through parse_str() to generate an associative array.) The basic use for these arguments is to pass theme-specific HTML tags to wrap the widget and its title.

Example

This will register 1 sidebar named Sidebar: 

register_sidebars();

This will create 2 sidebars named “Foobar 1″ and “Foobar 2″: 

register_sidebars(2, array('name'=>'Foobar %d'));

This will create 2 sidebars with <h1> and </h1> before and after the title: 

register_sidebars(2, array('before_title'=>'<h1>','after_title'=>'</h1>'));

Change Log

Since: 2.2.0

Source File

register_sidebars() is located in wp-includes/widgets.php.

Related

Widgets API: is_active_sidebar, register_sidebars, register_sidebar, unregister_sidebar, is_dynamic_sidebar, dynamic_sidebar, register_sidebar_widget, unregister_sidebar_widget, wp_register_sidebar_widget, wp_unregister_sidebar_widget, wp_get_sidebars_widgets, wp_set_sidebars_widgets, is_active_widget, the_widget, register_widget, unregister_widget, register_widget_control, unregister_widget_control, wp_register_widget_control, wp_unregister_widget_control, wp_convert_widget_settings, wp_get_widget_defaults, wp_widget_description

See also index of Function Reference and index of Template Tags.
Retrieved from "http://codex.wordpress.org/Function_Reference/register_sidebars"

Codex Resources