A field "checkbox" is a list of boxes (On / Off) to check, providing to a user multiple choices. Each choice offered by one of these boxes is an option. A field "checkbox" must contain at least one option.

Definition

A field "checkbox" is a list of boxes (On / Off) to check, providing to a user multiple choices. Each choice offered by one of these boxes is an option. A field "checkbox" must contain at least one option.

An option is composed of a part "text" and a part "value". The "text" is the text displayed on the form. The "value" is the recorded value, notably used in a template content or in a search process.

checkbox

Settings

checkbox_settings

Common Plugin Settings (Link to the article)

Construction

Options

Write at least one option of the list. The format is text = value. If an option contains only "value" or "text" then the 2 have the same value.

  • If the field is used in a search form, the search is performed only on the "value".
  • If several options are selected, the stored value is the concatenation of all values of selected options, separated by commas "," or other character designated by the parameter "Separator".
A value must be unique and should not be contained in another value. For example, we should not write the options in January = 1 and November=11 but January = 01 and November = 11. Thus, the values associated with January and November are different and any research on this field work.

Default Value

Optional, write the default option, by copying only the value of an option already assigned to this field. It is applied to the first load the form.
(Override) The default value of a field is overwritten by the value entered directly into the editing interface for a content type.

Ordering

Optional, select an option of this setting to order "checkbox" options:
  • Option1 (Following option): to maintain the existing order,
  • Option2 (Alphabetical A > Z): order the options in ascending alphabetical order (A-> Z), consider the "text" part of the option,
  • Option3 (Alphabetical Z > A): order the options in descending alphabetical order (Z-> A).

Orientation

Optional, select a horizontal or a vertical display of check boxes.
checkbox_orientation