InputfieldCheckboxes

Multiple checkbox toggles

Extends [[InputfieldSelectMultiple]] (which extends [[InputfieldSelect]]) — all option management methods (addOption(), addOptions(), setOptions(), addOptionsString(), etc.) are inherited and documented there. Returns an array value.

$f = $modules->get('InputfieldCheckboxes');
$f->name = 'colors';
$f->label = 'Favorite colors';
$f->addOptions(['red' => 'Red', 'green' => 'Green', 'blue' => 'Blue']);
$f->val(['red', 'blue']); // pre-check red and blue
$form->add($f);

See [[Inputfield]] for the shared Inputfield API (labels, collapsed states, showIf, rendering, processing, etc.).

Properties

Property	Type	Default	Description
`optionColumns`	`int`	`0`	Layout columns: `0`=stacked, `1`=inline, `2`–`10`=N columns (see Layout below)
`optionWidth`	`string`	`''`	Fixed CSS width per option, e.g. `'150px'` or `'10em'` 3.0.184+
`table`	`bool`	`false`	Render as a table instead of a list
`thead`	`string`	`''`	Pipe-separated column headings for table mode, e.g. `'Name\\|Description'`

Layout

By default, checkboxes render as a stacked vertical list. The layout can be changed with optionColumns or optionWidth.

optionColumns

$f->optionColumns = 0; // default: stacked vertical list
$f->optionColumns = 1; // inline: options flow side-by-side
$f->optionColumns = 3; // 3 equal-width columns (values 2–10 supported)

Values of 1 or greater than 10 both produce an inline/floated layout. Values 2–10 produce that many percentage-width columns.

optionWidth

An alternative to optionColumns that gives each option a fixed CSS width, producing responsive columns that wrap at narrow viewports.

$f->optionWidth = '200px'; // each option is 200px wide
$f->optionWidth = '12em'; // each option is 12em wide
$f->optionWidth = '1'; // auto-calculate width based on longest option label

When both optionColumns and optionWidth are set, optionWidth takes precedence.

Table mode

When table is true, checkboxes render in a <table> using [[MarkupAdminDataTable]] instead of a list. This is useful when options have multiple related columns.

$f->table = true;
$f->thead = 'Product|SKU|Price';
$f->addOption('a', 'Widget|WDG-001|$9.99');
$f->addOption('b', 'Gadget|GDG-002|$24.99');

The | character in option labels becomes a column separator in the table. The thead string defines the column headers using the same | separator.

Notes

The size attribute from InputfieldSelectMultiple is not used and is set to null.
Optgroups are not supported (unlike InputfieldSelect).
After processInput(), $f->val() returns an array of checked option values.
Source file: wire/modules/Inputfield/InputfieldCheckboxes/InputfieldCheckboxes.module

API reference: methods, properties, hooks

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the InputfieldCheckboxes class also inherits all the methods and properties of: InputfieldSelectMultiple, InputfieldSelect, Inputfield, WireData and Wire.

Common
Properties

Common

Name	Return	Summary
InputfieldCheckboxes::getConfigInputfields() InputfieldCheckboxes::getConfigInputfields() InputfieldCheckboxes::getConfigInputfields()	None
InputfieldCheckboxes::getOptionWidthCSS() InputfieldCheckboxes::getOptionWidthCSS($optionWidth, array $options) InputfieldCheckboxes::getOptionWidthCSS($optionWidth, array $options)	`string`	Get CSS width and unit for option width
InputfieldCheckboxes::render() InputfieldCheckboxes::render() InputfieldCheckboxes::render()	`string`	Render
InputfieldCheckboxes::set() InputfieldCheckboxes::set($key, $value) InputfieldCheckboxes::set($key, $value)	None

Properties

Name	Return	Summary
InputfieldCheckboxes::optionColumns	`int` `bool`	Specify 1 for inline list of options, or qty of columns to list options in. DEFAULT: 0
InputfieldCheckboxes::optionWidth	`string`	Alternative to optionColumns, specify option width like '222px', '22em', etc. or '1' for auto. 3.0.184+ DEFAULT: ''
InputfieldCheckboxes::table	`bool`	Whether or not to display as a table DEFAULT: false
InputfieldCheckboxes::thead	`string`	Pipe "\|" separated list of table headings. Do the same for the addOption() labels. DEFAULT: ''

Additional methods and properties

In addition to the methods and properties above, InputfieldCheckboxes also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.267