跳至主要内容
版本：5.1

Groupedlist表单字段

**groupedlist** 表单字段类型提供了一个自定义定义条目的下拉列表或列表框，并且能够显示分组数据。如果字段具有保存的值，则在页面首次加载时会选择该值。如果没有，则选择默认值（如果有）。

  • **type**（必填）必须为groupedlist。
  • **name**（必填）是字段的唯一名称。
  • **label**（必填）（可翻译）是字段的 HTML 标签。
  • **description**（可选）（可翻译）是字段描述。
  • **default**（可选）（不可翻译）是默认值，但对文件意义不大。
  • **class**（可选）是 HTML 表单字段的 CSS 类名。如果省略，则默认为“inputbox”。
  • **multiple**（可选）是否可以同时选择多个项目（true 或 false）。

实现于：libraries/src/Form/GroupedlistField.php

XML <field> 元素必须包含一个或多个 <option> 元素，这些元素定义列表项。<option> 和 </option> 标签之间的文本将显示在下拉列表中，并且是一个可翻译的字符串。<option> 标签采用以下参数

  • value（必填）如果选择了此项，则将为字段保存的值。

提示：不要忘记使用 </field> 关闭字段定义。

要对数据进行分组，只需在要分组的 <option> 元素之前放置一个 <group>，并在其之后放置一个 </group>。<group> 标签采用以下参数

  • label（可翻译）是列表中显示的文本。

XML 参数定义示例​

<field
        name="mylistvalue" 
        type="groupedlist" 
        default="" 
        label="Select an option" 
        description="">
        <group label="Group 1">
          <option value="0">Option 1</option>
          <option value="1">Option 2</option>
        </group>
        <group label="Group 2">
          <option value="3">Option 3</option>
          <option value="4">Option 4</option>
        </group>
        <option value="5">Option 5</option>
        <option value="6">Option 6</option>
</field>

另请参阅​