Collections functions
Encryption functions
General functions
Theme permission functions
Resource functions

config_add_checkbox_select()

Description

Return a data structure that will instruct the configuration page generator functions to
add a multi select configuration variable to the setup page.

used as the values of the options, and the values are the choices the user sees. (But see
$usekeys, below.) Usually a $lang entry whose value is an array of strings.
If set to false the values from $choices will be used for both the values of the options
and the text the user sees. Defaulted to true.

Parameters

ColumnTypeDefaultDescription
$config_var string the name of the configuration variable to be added.
$label string the user text displayed to label the select block. Usually a $lang string.
$choices
$usekeys boolean true tells whether to use the keys from $choices as the values of the options.
$width integer 300 the width of the input field in pixels. Default: 300.
$columns 1
$autosave false
$on_change_js null
$hidden false
array string $choices the array of choices -- the options in the select block. The keys are

Location

include/config_functions.php lines 809 to 812

Definition

 
function config_add_checkbox_select($config_var$label$choices$usekeys=true$width=300$columns=1$autosave false$on_change_js=null$hidden=false)
    {
    return array(
'checkbox_select'$config_var$label$choices$usekeys$width$columns$autosave$on_change_js$hidden);
    }

This article was last updated 10th July 2020 22:35 Europe/London time based on the source file dated 8th July 2020 11:40 Europe/London time.