helpers\BaseHtml activeCheckboxList()

The model object

The attribute name or expression. See getAttributeName() for the format about attribute expression.

The data item used to generate the checkboxes. The array keys are the checkbox values, and the array values are the corresponding labels. Note that the labels will NOT be HTML-encoded, while the values will.

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. You may set this option to be null to prevent default value submission. If this option is not set, an empty string will be submitted.
• 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.

See renderTagAttributes() for details on how attributes are being rendered.

The generated checkbox list