Sidebar

import Screenshots from '@site/src/components/Screenshots';

The sidebar field allows you to select one or multiple sidebars. This field has several settings that can be displayed as a: simple select dropdown, checkbox list, or beautiful select dropdown with select2 library.

Screenshots

<Screenshots name="sidebar" col1={[ ['https://imgur.elightup.com/VTvvKSR.png', 'The sidebar field default interface'], ['https://imgur.elightup.com/WOcCGA5.png', 'The sidebar field with checkbox list interface'], ['https://imgur.elightup.com/jp9BFqE.png', 'The sidebar field with radio list interface'], ]} />

Settings

Besides the common settings, this field has the following specific settings, the keys are for use with code:

This field inherits the look and field (and settings) from other fields, depending on the field type, which accepts the following value:

This is a sample field settings array when creating this field with code:

[
    'name'        => 'Sidebar',
    'id'          => 'sidebar',
    'type'        => 'sidebar',
    'field_type'  => 'select_advanced',
    'placeholder' => 'Select a sidebar',
],

Data

This field saves sidebar ID(s) in the database.

If "Multiple" is not set, a single sidebar ID is saved in the database. Otherwise, the field saves multiple sidebar IDs in the database, where each sidebar ID is stored in a single row in the database with the same meta key (similar to what add_post_meta does with the last parameter false).

If the field is cloneable, then the value is stored as a serialized array in a single row in the database.

Template usage

Display widgets for the selected sidebar:

<div class="sidebar">
    <?php rwmb_the_value( 'my_field_id' ) ?>
</div>

Checking if the selected sidebar has widgets and displaying it:

<?php
$sidebar_id = rwmb_meta( 'my_field_id' );
if ( is_active_sidebar( $sidebar_id ) ) {
    dynamic_sidebar( $sidebar_id );
}