[ Close ] Introducing Carbon Fields Version 3 - now with Gutenberg Blocks Support


Documentation > Fields > Choose Sidebar

Choose Sidebar

Deprecated in favor of the Sidebar field.

Adds a drop-down field that lists existing sidebars and provides the ability to add new sidebars to the site.

Setup methods


Remove the ability to add new sidebars to the site.


Set the options used for sidebars created by this field. See register_sidebar() for more information.

This method can accept an associative array of options, or an array of associative arrays with options for each sidebar.

The default options are:

    'before_widget' => '<li id="%1$s" class="widget %2$s">',
    'after_widget' => '</li>',
    'before_title' => '<h2 class="widgettitle">',
    'after_title' => '</h2>',

The example below shows how to create a Choose Sidebar field with custom sidebar options and help text:

Field::make("choose_sidebar", "crb_custom_sidebar", __('Sidebar'))
    ->help_text('Select which sidebar to show in this page, or click "Add New" to create a new one')
        'before_widget' => '<div id="%1$s" class="widget %2$s">',
        'after_widget' => '</div>',
        'before_title' => '<h3 class="widgettitle">',
        'after_title' => '<div class="cl">&nbsp;</div></h3>',

The following example sets different sidebar options for each of the specified sidebars:

Field::make( 'choose_sidebar', 'crb_custom_sidebar', __('Sidebar') )
        'default' => array(
            'before_widget' => '<li id="%1$s" class="widget %2$s">',
            'after_widget'  => '</li>',
            'before_title'  => '<h2 class="widget-title">',
            'after_title'   => '</h2>',
        'blog-sidebar' => array(
            'before_widget' => '<div id="%1$s" class="widget %2$s">',
            'after_widget'  => '</div>',
            'before_title'  => '<h4 class="blog-widget-title">',
            'after_title'   => '</h4>',

Excited about Carbon Fields? Spread the word!