checkboxList()
Generates a list of checkboxes.
A checkbox list allows multiple selection, like listBox(). As a result, the corresponding submitted value is an array.
public static string checkboxList ( $name, $selection = null, $items = [], $options = [] ) |
---|
$name | string |
The name attribute of each checkbox. |
$selection |
string|array|null
|
The selected value(s). String for single or array for multiple selection(s). |
$items | array |
The data item used to generate the checkboxes. The array keys are the checkbox values, while the array values are the corresponding labels. |
$options | array |
Options (name => config) for the checkbox list container tag. The following options are specially handled: - tag: string|false, the tag name of the container element. False to render checkbox without container. See also tag().
- unselect: string, the value that should be submitted when none of the checkboxes is selected. By setting this option, a hidden input will be generated.
- encode: boolean, whether to HTML-encode the checkbox labels. Defaults to true. This option is ignored if
item option is set. - separator: string, the HTML code that separates items.
- itemOptions: array, the options for generating the checkbox tag using checkbox().
-
item: callable, a callback that can be used to customize the generation of the HTML code corresponding to a single item in $items. The signature of this callback must be: function ($index, $label, $name, $checked, $value)
where $index is the zero-based index of the checkbox in the whole list; $label is the label for the checkbox; and $name, $value and $checked represent the name, value and the checked status of the checkbox input, respectively.
See renderTagAttributes() for details on how attributes are being rendered. |
return | string |
The generated checkbox list |
Please login to continue.