Skip to main content

Widgetised sidebars

Type: widgetised_sidebars

Description

Dropdown of registered widget areas/sidebars.

Screenshot

Widgetised Sidebars

Basic Usage

[
"type" => "widgetised_sidebars",
"heading" => __("Field Label", "your-text-domain"),
"param_name" => "your_param_name",
"description" => __("Field description", "your-text-domain"),
]

Common Parameters

All param types support these common parameters:

ParameterTypeDescription
typeStringRequired. Must be "widgetised_sidebars"
holderStringHTML tag name where the value is displayed in backend edit mode. Default: hidden input
classStringCSS class added to the holder HTML tag
headingStringLabel shown in the editor interface
param_nameStringRequired. Parameter name used in shortcode
valueMixedValue for the parameter
descriptionStringHelp text shown below the field
groupStringTab/group name to organize parameters
sectionStringSection slug to visually group params within a tab
weightIntegerDisplay order (higher = shows first)
edit_field_classStringCSS class for field width (e.g., "vc_col-sm-6")
dependencyArrayShow/hide based on other field values
admin_labelBooleanShow value in element title bar
param_holder_classStringCSS class for the param wrapper in the edit element modal
save_alwaysBooleanForce saving the value even if it equals the default or is empty
callbackArrayJavaScript function callback (e.g., ['after_add' => 'myCallback'])
settingsArrayType-specific configuration options (see Type-Specific Parameters below)
deprecatedStringVersion in which the param was deprecated

Complete Example

<?php
add_action('vc_before_init', 'my_element_with_widgetised_sidebars');
function my_element_with_widgetised_sidebars() {
vc_map([
"name" => __("My Element", "domain"),
"base" => "my_element",
"category" => __("My Category", "domain"),
"params" => [
[
"type" => "widgetised_sidebars",
"heading" => __("Field Label", "domain"),
"param_name" => "param_name",
"description" => __("Field description", "domain"),
],
],
]);
}