InputfieldCheckbox class

Single checkbox toggle

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

Common

Name	Return	Summary
InputfieldCheckbox::autocheck	`int`	When set to 1, setting value attribute to non-blank/non-zero automatically triggers checked.
InputfieldCheckbox::checkboxLabel	`string`	Same as label2, but used as part of field config rather than API-only config.
InputfieldCheckbox::checkboxOnly	`bool`	Show only the checkbox without label text next to it? (default=false) @since 3.0.144
InputfieldCheckbox::checked() InputfieldCheckbox::checked() InputfieldCheckbox::checked($checked = null)	`bool`	Get or set current checkbox boolean attribute state
InputfieldCheckbox::checkedValue	`string`	Value when checked (default=1)
InputfieldCheckbox::getConfigInputfields() InputfieldCheckbox::getConfigInputfields() InputfieldCheckbox::getConfigInputfields()	`InputfieldWrapper`	Configure checkbox field
InputfieldCheckbox::isEmpty() InputfieldCheckbox::isEmpty() InputfieldCheckbox::isEmpty()	`bool`	Is empty (checkbox not checked)?
InputfieldCheckbox::label2	`string`	Alterate label to display next to checkbox (default=use regular label)
InputfieldCheckbox::labelAttrs	`array`	Optional attributes for <label> element that surrounds checkbox (default=[]) @since 3.0.141
InputfieldCheckbox::processInput() InputfieldCheckbox::processInput(WireInputData $input) InputfieldCheckbox::processInput(WireInputData $input)	`$this`	Process input
InputfieldCheckbox::render() InputfieldCheckbox::render() InputfieldCheckbox::render()	`string`	Render checkbox input
InputfieldCheckbox::renderValue() InputfieldCheckbox::renderValue() InputfieldCheckbox::renderValue()	`string`	Render value only
InputfieldCheckbox::set() InputfieldCheckbox::set(string $key, mixed $value) InputfieldCheckbox::set(string $key, mixed $value)	`InputfieldCheckbox` `Inputfield`	Set property
InputfieldCheckbox::setAttribute() InputfieldCheckbox::setAttribute($key, $value) InputfieldCheckbox::setAttribute($key, $value)	`Inputfield` `InputfieldCheckbox`	Set attribute
InputfieldCheckbox::uncheckedValue	`string`	Value when not checked (default='', blank string)
InputfieldCheckbox::wired() InputfieldCheckbox::wired() InputfieldCheckbox::wired()	(nothing)	Wired to ProcessWire instance

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Single checkbox toggle

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news