register_sidebar( array|string $args = array() ): string

User Contributed Notes

1. Skip to note 7 content

   Codex 9 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 7You must log in to vote on the helpfulness of this note

   This example creates a sidebar named “Main Sidebar” with and before and after the title.

   /**
    * Add a sidebar.
    */
   function wpdocs_theme_slug_widgets_init() {
   	register_sidebar( array(
   		'name'          => __( 'Main Sidebar', 'textdomain' ),
   		'id'            => 'sidebar-1',
   		'description'   => __( 'Widgets in this area will be shown on all posts and pages.', 'textdomain' ),
   		'before_widget' => '<li id="%1$s" class="widget %2$s">',
   		'after_widget'  => '</li>',
   		'before_title'  => '<h2 class="widgettitle">',
   		'after_title'   => '</h2>',
   	) );
   }
   add_action( 'widgets_init', 'wpdocs_theme_slug_widgets_init' );
2. Skip to note 8 content

   tazotodua 6 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note

   To output registered sidebar:

   <?php if ( is_active_sidebar( 'your-sidebar-slug' ) ) { ?>
   	<ul id="sidebar">
   		<?php dynamic_sidebar('your-sidebar-slug'); ?>
   	</ul>
   <?php } ?>
3. Skip to note 9 content

   Stefan Budimirovic 5 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

   /* Better way to add multiple widgets areas */
   function widget_registration($name, $id, $description,$beforeWidget, $afterWidget, $beforeTitle, $afterTitle){
   	register_sidebar( array(
   		'name' => $name,
   		'id' => $id,
   		'description' => $description,
   		'before_widget' => $beforeWidget,
   		'after_widget' => $afterWidget,
   		'before_title' => $beforeTitle,
   		'after_title' => $afterTitle,
   	));
   }
   
   function multiple_widget_init(){
   	widget_registration('Footer widget 1', 'footer-sidebar-1', 'test', '', '', '', '');
   	widget_registration('Footer widget 2', 'footer-sidebar-2', 'test', '', '', '', '');
   	// ETC...
   }
   
   add_action('widgets_init', 'multiple_widget_init');
4. Skip to note 10 content

   jave.web 8 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

   Sidebar id must be in lowercase ! (and no spaces)
   From codex: id – Sidebar id – Must be all in lowercase, with no spaces (default is a numeric auto-incremented ID). If you do not set the id argument value, you will get E_USER_NOTICE messages in debug mode, starting with version 4.2.
5. Skip to note 11 content

   Vanoisbe 6 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   /* Add Multiple sidebar 
   */
   if ( function_exists('register_sidebar') ) {
   	$sidebar1 = array(
   		'before_widget' => '<div class="widget %2$s">',
   		'after_widget' => '</div>',
   		'before_title' => '<h2 class="widgettitle">',
   		'after_title' => '</h2>',        
   		'name'=>__( 'My sidebar 1', 'textdomain' ),	
   	);	
   	$sidebar2 = array(
   		'before_widget' => '<div class="widget %2$s">',
   		'after_widget' => '</div>',
   		'before_title' => '<h2 class="widgettitle">',
   		'after_title' => '</h2>',        
   		'name'=>__( 'My sidebar 2', 'textdomain' ),	
   	);
       $sidebar3 = array(
   		'before_widget' => '<div class="widget %2$s">',
   		'after_widget' => '</div>',
   		'before_title' => '<h2 class="widgettitle">',
   		'after_title' => '</h2>',        
   		'name'=>__( 'My sidebar 3', 'textdomain' ),	
   	);
       $sidebar4 = array(
   		'before_widget' => '<div class="widget %2$s">',
   		'after_widget' => '</div>',
   		'before_title' => '<h2 class="widgettitle">',
   		'after_title' => '</h2>',        
   		'name'=>__( 'My sidebar 4', 'textdomain' ),	
   	);
   	
   	register_sidebar($sidebar1);
   	register_sidebar($sidebar2);
       register_sidebar($sidebar3);
       register_sidebar($sidebar4);
   }

   • Since in your example above you are adding multiple sidebars with pretty much the same styling, you can use register_sidebars instead.

     Gwyneth Llewelyn 4 years ago
6. Skip to note 12 content

   gabrielsgsm 2 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   Note: when calling is_sidebar_active() or dynamic_sidebar(), the argument passed in these function is always sanitized via sanitize_title(). This function, amongst the other transforms, also lowercases the $index that is being passed.

   When using those two functions, you should remember to register the sidebar name in all lowercase and with a sanitize_title() compatible id, otherwise calling the widget area will always return false.