フィールドグループ(繰り返し)


この機能は Ver. 3.3.0 で追加予定の、リリース前の機能です

このページは、アルファ版(Ver. 3.3.0-alpha.1)時点の内容です。正式版までに仕様や設定項目が変わる可能性があります。本番サイトでは使わず、検証環境でお試しください。

フィールドグループは、同じ形の入力を何項目も繰り返す器です(スタッフ一覧・沿革・よくある質問など)。値は、従来のカスタムフィールドグループと同じ形で保存されます。そのため、テンプレートは従来と同じループで書けます。

作る手順

「スタッフ紹介」として、名前・役職・写真・コメントを繰り返す例です。「フィールドグループ」の型でキー staff・ラベル「スタッフ」の器を追加し、高度な設定で最小項目数 1・最大項目数 10・「項目を閉じて表示する」を設定します。器の中に、「行(横並び)」(名前 staff_name(必須入力「保存時に必須」)と役職 staff_role)、メディア画像 staff_photo、テキストエリア staff_comment を追加します。

器の設定

設定項目(画面)

config のキー

内容

既定値

入力例

最小項目数

minRows

入力しなければならない項目の数です。すべての欄が空の項目は、項目として数えません。

制限なし

1

最大項目数

maxRows

入力できる項目の数の上限です。

制限なし

10

同じ内容の項目を禁止する

unique

同じ内容の項目があると保存できません。

オフ

—

項目を閉じて表示する

collapsed

編集画面で、保存済みの項目を閉じた状態で表示します。足した項目と、エラーのある項目は開きます。

オフ

—

項目ごとにブロックを 1 つ選ぶ

componentPerRow

項目ごとに形の違う入力を並べます(項目ごとにブロックを選ぶフィールドグループ)。プロフェッショナルライセンス以上で使えます。

オフ

—

フィールドグループの設定
フィールドグループの設定

定義の例(テーマの JSON で書いた場合):

{
  "version": 1,
  "entityType": "entry",
  "sets": [
    {
      "code": "staff",
      "label": "スタッフ紹介",
      "fields": [
        { "key": "staff", "label": "スタッフ", "type": "group",
          "config": { "minRows": 1, "maxRows": 10, "collapsed": true } },
        { "key": "staff_row", "label": "名前と役職", "type": "row", "parentKey": "staff" },
        { "key": "staff_name", "label": "名前", "type": "text", "parentKey": "staff_row",
          "validation": { "required": "save", "rules": [] } },
        { "key": "staff_role", "label": "役職", "type": "text", "parentKey": "staff_row" },
        { "key": "staff_photo", "label": "写真", "type": "media-image", "parentKey": "staff" },
        { "key": "staff_comment", "label": "コメント", "type": "textarea", "parentKey": "staff" }
      ]
    }
  ]
}

器の中に置けるもの

置けるもの

置けないもの

値を 1 つ持つ型(テキスト・テキストエリア・単一のセレクトボックス・単一の on/off のチェックボックス・ラジオボタン・日付・数値・メディア画像・メディアファイル・1 件を選ぶ参照・ブロックエディターなど)、見出し・メッセージ、行(横並び)・タブの入れ物・タブ・アコーディオン、コンポーネントのフィールド

フィールドグループ(入れ子にはできません)、隠し値(hidden)・地図・アーカイブ画像・アーカイブファイル、複数の値を持つ型(複数選択のチェックボックス・セレクトボックス、メディアギャラリー、複数を選ぶ参照)、テーマ・プラグインのフィールド型

編集画面での見え方

  • 器の中に「項目 1」「項目 2」…が並びます。項目は追加・移動・削除・並べ替えができます。

  • 閉じた項目の見出しには、最初に値のある文字の欄の内容が要約として出ます。

  • 必須は項目ごとに確かめます。すべての欄が空の項目は項目として数えず、必須も問いません。どれかの欄が埋まった項目で、必須の欄が空ならエラーになります。

保存されるキー

器のキー staff に対して、@staff という宣言(値はメンバーのキーの並び)と、メンバーごとの値の並びを保存します。行(横並び)の staff_row は値を持たないため、メンバーに含まれません。

キー

保存される値(項目が 2 つの例)

@staff

staff_name・staff_role・staff_photo・staff_comment

staff_name

山田、佐藤

staff_role

店長、スタッフ

staff_photo・staff_photo@media

メディアの ID の並び

staff_comment

コメントの並び

メンバーはすべて同じ数の値を持ちます(空の欄は空の値として保存します)。

テンプレートの例

標準のテンプレートでは、<!-- BEGIN 器のキー:loop --> の中にメンバーの変数を書きます。メディアの @path などの派生キーも、ループの中で使えます。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN staff:veil -->
<ul class="staff-list">
  <!-- BEGIN staff:loop -->
  <li class="staff-item">
    <!-- BEGIN staff_photo:veil -->
    <img src="%{MEDIA_ARCHIVES_DIR}{staff_photo@path}" alt="{staff_photo@alt}" width="{staff_photo@width}" height="{staff_photo@height}">
    <!-- END staff_photo:veil -->
    <p class="staff-name">{staff_name}<span>{staff_role}</span></p>
    <p>{staff_comment}[nl2br]</p>
  </li>
  <!-- END staff:loop -->
</ul>
<!-- END staff:veil -->
<!-- END_MODULE Entry_Field -->

Twig では、器のキーで項目の並びを取り、項目.メンバー.value で読みます。

{% set f = module('V2_Entry_Field').fields %}
{% if f.staff %}
<ul class="staff-list">
  {% for row in f.staff %}
  <li class="staff-item">
    <p class="staff-name">{{ row.staff_name.value }}<span>{{ row.staff_role.value }}</span></p>
    <p>{{ row.staff_comment.value|nl2br }}</p>
  </li>
  {% endfor %}
</ul>
{% endif %}

注意

  • テーマのテンプレート(field.html)に同じ名前のフィールドグループ(@staff)があると、定義の側のフィールドグループは器ごと編集画面に出ず、値も保存されません。

  • テーマの JS が繰り返しの入力を name 属性で探している場合、定義のフィールドグループの入力は見つかりません(入力には name がありません)。項目を足したときの処理は、JS イベント field-group.add.after で受け取れます。

  • フィールドグループの中の欄は、「権限・ロール別の表示」を個別には設定できません。