Checkbox

Type	Version	Admin Panels	Admin Tabs	Meta Boxes	Theme Customizer
checkbox	1.8	✔️	✔️	✔️	✔️

Description

Display a checkbox field.

Option Details & Parameters

Returns: boolean (If the checkbox is checked it will return true otherwise false.)

Parameter	Type	Description
name	string	The name of the option, for display purposes only.
id	string	A unique ID for this option. This ID will be used to get the value for this option.
desc	string	(Optional) The description to display together with this option.
default	boolean	The default value for this option.
livepreview	string	(Optional) jQuery code that updates something in your site in the live preview. Only used when the option is placed in a theme customizer section. Refer to Livepreview for more information on this parameter.
css	string	(Optional) CSS rules to be used with this option. Only used when the option is placed in an admin page / panel or a theme customizer section. Refer to Generate CSS Automatically for your options for more information on this parameter.

Examples

Creating a checkbox option:

$panel->createOption( array(
'name' => 'My Checkbox Option',
'id' => 'my_checkbox_option',
'type' => 'checkbox',
'desc' => 'This is our option',
'default' => false,
) );