checkbox.md

Checkbox

Checkbox field renders a set of native labeled checkboxes. Supports initial checked or disabled attributes.

Example configuration

...
array(
    'title' => 'My checkbox field title',
    'id' => 'checkbox-option',
    'desc' => 'Short description for the field',
    'place' => array(
        'page' => 'my-options-page',
        'tab' => 'main',
    ),
    'type' => 'checkbox',
    'choices' => ['First label', 'Second label', 'Third label']
),
...

This will produce the following

It will use the label text as the value. If you wish to separate values from labels use the following syntax for the choices key:

...
'choices' => array(
    array(
        'value' => 'First value',
        'label' => 'First label',
    ),
    array(
        'value' => 'Second value',
        'label' => 'Second label',
    ),
    array(
        'value' => 'Third value',
        'label' => 'Third label',
    ),
)
...

checked and disabled

If checked or disabled keys are specified, they'll be respected. E.g:

...
'choices' => array(
    array(
        'value' => 'First value',
        'label' => 'First label',
    ),
    array(
        'value' => 'Second value',
        'label' => 'Second label',
        'checked' => true,
    ),
    array(
        'value' => 'Third value',
        'label' => 'Third label',
        'disabled' => true,
    ),
)
...

will result in the following

Notice that the second option is always checked (and cannot be unchecked) and the third option is not checkable.

Params

Name	Type	Description
type	string	checkbox (required)
id	string	Unique ID that will be used to retrieve the value (required)
place	array	Specifies where (page and tab) this option will be rendered
title	string	Shows a heading to the left of the field
desc	string	Shows a description text (can have HTML)
choices	array	Kind of required, but will not render anything if no choices are provided. Can be an array of strings or an array of arrays with value and label keys. See examples above.