跳至主要内容
版本：5.1

复选框表单字段

复选框表单字段类型提供一个单选复选框。如果参数具有保存的值，则在页面首次加载时选中该值。如果没有，则选中默认值（如果有）。

  • type（必填）必须为checkbox。
  • name（必填）是字段的唯一名称。
  • label（必填）（可翻译）是字段的 HTML 标签。
  • value（可选）是如果选中此复选框，则参数的值（通常为 1）。
  • checked（可选）应设置为 1 以默认选中复选框，或设置为 0 以不选中。
  • description（可选）（可翻译）是字段描述。
  • class（可选）允许您设置一个用于显示的 CSS 类。如果省略，这将默认为 'inputbox'。
  • multiple（可选）如果设置为 true，允许同时选择多个项目。设置为 false 以允许单选。

实现方式：libraries/src/Form/Field/CheckboxField.php

示例 XML 参数定义​

<field
        name="show_title" 
        type="checkbox" 
        label="Show title" 
        description="Show the title of the item" 
        value="1"
/>

示例 XML 参数定义（带有选中的复选框）​

<field
        name="show_title" 
        type="checkbox" 
        label="Show title" 
        description="Show the title of the item" 
        value="1"
        checked="1"
/>
警告

保存表单中的复选框时，需要特别注意！这是一个常见的错误。您会发现，在保存包含未选中复选框的表单时，POST 信息中没有该变量，这是标准的浏览器行为。

有关如何处理此问题的建议，请参阅 此页面 上的讨论。