カスタムフィールド定義の概要
この機能は Ver. 3.3.0 で追加予定の、リリース前の機能です
このページは、アルファ版(Ver. 3.3.0-alpha.1)時点の内容です。正式版までに仕様や設定項目が変わる可能性があります。本番サイトでは使わず、検証環境でお試しください。
Ver. 3.3.0 では、管理画面の「フィールド定義」で、カスタムフィールドの入力項目を定義できます。定義すると、エントリーなどの編集画面に入力欄が自動で出ます。テンプレートに入力欄の HTML を書く必要はありません。
値は、従来のカスタムフィールドと同じテーブルに、定義したキーで保存されます。そのため、公開側のテンプレートは従来と同じ {キー} の書き方で値を出せます。
できること
管理画面で、入力項目の追加・編集・複製・削除・並び替えができます。
テキスト・選択肢・日付・数値のほか、メディア、エントリー・カテゴリー・ユーザーの参照、ブロックエディター、地図などの型を選べます(型の一覧)。
必須を「任意」「保存時に必須」「公開時に必須」から選べます。必須と入力チェックは、サーバー側でも必ず確かめます。
カテゴリーなどの条件でフィールドセットを出し分けたり、ほかのフィールドの値によってフィールドを出し入れしたりできます。
権限・ロールごとに、編集できる・読み取り専用・表示しないを決められます。
行(横並び)・タブ・アコーディオンで入力欄を整理し、エントリーでは本文の上・本文の下・サイドバーに出し分けられます。
繰り返し入力する項目(フィールドグループ)や、使い回せるフィールドの組(コンポーネント)を作れます。
定義を JSON でエクスポート・インポートしたり、テーマに置いて配布したりできます。
プラグインから、独自のフィールド型や表示する場所を足せます。
従来のカスタムフィールドとの違い
従来のカスタムフィールドは、テーマのテンプレート(admin/entry/field.html など)に入力欄の HTML を書いて作ります。カスタムフィールド定義は、定義を管理画面(データベース)か、テーマの JSON ファイルに持ちます。
従来のカスタムフィールド | カスタムフィールド定義 | |
|---|---|---|
定義の置き場所 | テーマのテンプレート | 管理画面(データベース)、またはテーマの JSON ファイル |
入力欄 | HTML を書く(カスタムフィールドメーカーで生成できます) | 編集画面に自動で出ます |
値の保存先 | カスタムフィールドのテーブル | 同じ(定義したキーで保存します) |
公開側での出し方 |
| 同じ |
必須・入力チェック | テンプレートに | 定義に設定します。サーバー側で必ず確かめます |
繰り返し |
| 型「フィールドグループ」で作ります。保存の形は同じです |
2 つの方式は併用できます。既存のテンプレートは、そのまま動き続けます。同じキーを両方に書いたときの扱いや、従来のフィールドを定義へ移す手順は「従来のカスタムフィールドとの併用と移行」を参照してください。
用語
用語 | 意味 |
|---|---|
フィールドセット | フィールド定義をまとめる単位です。表示条件(どの画面で出すか)と、表示する場所を持ちます。 |
フィールド定義(フィールド) | 入力項目 1 つ分の定義です。キー・ラベル・型・必須・入力チェックなどを持ちます。 |
キー | 値を保存する名前です。テンプレートでは |
フィールドグループ | 同じ形の入力を何項目も繰り返す仕組みです。従来のカスタムフィールドグループと同じ形で保存します。フィールドセットとは別のものです。 |
コンポーネント | いくつかのフィールドの組に名前を付け、ほかのフィールドセットから使い回せるようにしたものです。 |
テーマ由来の定義 | テーマの JSON ファイルで宣言した定義です。管理画面では編集できません。 |
継承 | 親ブログのフィールドセットを、子孫のブログでも使えるようにすることです。 |
派生キー |
|
対象
定義を作れる対象は、エントリー・カテゴリー・ブログ・ユーザー・モジュールの 5 つです。定義画面の上部のタブで、対象を切り替えます。タブにはほかに「コンポーネント」があります。
対象 | 編集画面で入力欄が出る位置 |
|---|---|
エントリー | 本文の上(標準)。フィールドセットごとに、本文の下・サイドバーも選べます |
カテゴリー・ブログ・ユーザー | 「カスタム設定」タブの中。テンプレートで作ったカスタムフィールドの後ろに出ます |
モジュール | モジュール ID の編集画面の「カスタム設定」タブの中。モジュール ID の設定で「カスタムフィールドを表示」にチェックしたものだけに出ます |
ユニット(カスタムユニット)とフォームの項目は、対象ではありません。
エディションと権限
次の型と機能は、プロフェッショナルライセンス以上で使えます。
型「隠し値(hidden)」「メディアギャラリー」「地図」
フィールドグループの設定「項目ごとにブロックを 1 つ選ぶ」
スタンダードライセンスでは、型を選ぶ画面に「Pro」の印が付き、選べません。テーマやインポートで入ったこれらの定義は「プロフェッショナルライセンス以上が必要(読み取り専用)」と表示され、編集できません。
定義画面は、管理画面のメニュー「フィールド定義」から開きます。開ける人は次のとおりです。
ロールを使っていないユーザー: そのブログの管理者の権限があれば開けます。
ロールを使っているユーザー: ロールの設定で「フィールド定義の編集」にチェックが入っていれば開けます。
プレビュー中は開けません。
このドキュメントの読み方
はじめての方は「はじめてのフィールド定義」で、定義から公開側の表示までを一通り試してください。
ページ | 内容 |
|---|---|
定義を作り、編集画面で入力し、テンプレートで出すまでの通しの手順 | |
フィールドセットの作成、表示する場所、表示条件 | |
フィールドの追加、必須、入力チェック、条件付き表示、権限・ロール別の表示 | |
テキスト・選択肢・日付・数値などの型の設定 | |
メディア・参照・地図・アップロード・ブロックエディターの型の設定 | |
見出し・メッセージ・行・タブ・アコーディオン | |
繰り返し入力する項目 | |
フィールドの組の使い回し | |
項目ごとに形の違う入力を並べる | |
基本の型のテンプレートの書き方 | |
メディア・参照・地図などのテンプレートの書き方 | |
テーマの JSON で定義を配布する | |
テーマでパターン・独自の型・表示する場所を足す | |
従来のカスタムフィールドとの併用、移行の手順 | |
うまくいかないときの確認点 | |
プラグインからの拡張(Hook・登録口・JS イベント) |

