【Craft 5 の新機能】フィールドインスタンスについて

Craft 5 では従来の使いやすさはそのままに、さらに利便性を高める機能がいくつか追加されました。

Features
https://craftcms.com/features

そこで、オススメしたい Craft 5 の新機能について、これから数回に分けてご紹介していきます。

初回となる今回は「フィールドインスタンス」について見ていきましょう。
これは Craft CMS Advent Calendar 2024 14日目の記事です。

フィールドインスタンスとは

Craft CMS のフィールドインスタンスは、設定が同じフィールドを再利用するための機能です。

従来であれば、フィールドレイアウトに配置したい数のフィールドを用意しておく必要がありましたが、Craft 5 から任意のフィールドをインスタンスとして複数回設置できるようになりました。

同じフィールドを2つセットしたフィールドレイアウトのサンプル

キャプチャ画像は、1行テキスト(text_singleLine) を2つセットしている例です。

インスタンスの設定を調整する

インスタンスの「アクション」メニュー

インスタンスの設定を調整する場合、フィールドの右にある ⋯(アクション) ボタンのプルダウンから 設定 を選択します。

インスタンス設定の編集画面

スライドアウト UI で表示されるフィールド設定の編集画面で、 インスタンスごとの調整を加えましょう。

執筆時点の最新版(Craft 5.5.7)で設定できる項目は、以下の通りです。

  • ラベル
  • ハンドル
  • 説明
  • ヒント
  • 警告
  • 現在のユーザーの条件
  • エントリの条件

変更が加えられているインスタンス

変更が加えられた項目が判別できるよう、アイコンが表示されます。

エントリ編集画面のサンプル

編集画面で確認しても、同じフィールドが異なる設定で表示されていることが確認できます。

リレーションフィールドが対応しているのは Craft 5.3 以降

とても便利な機能ですが、エントリやアセットといったリレーションフィールドは Craft 5.3 以降でのみ対応している点に注意してください。

Craft 5.3 Released | Craft CMS
https://craftcms.com/blog/craft-5-3-released

古いバージョンでは、フィールド設定が同じ場合でも必要な数だけフィールドを作成することになりますが、Craft 5.3 でフィールドを統合できるコンソールコマンドが用意されているので、心配はいりません。

まとめ

Craft 5 で追加されたフィールドインスタンスは、任意のフィールドを複数回使いたい場合にとても便利な機能です。
柔軟なフィールドレイアウトを最小限のフィールドで実現できるため、管理のしやすさも向上します。

ただし、リレーションフィールドを使う場合は Craft 5.3 以降でないと利用できないので、バージョンに注意しましょう。