フィールドの追加と共通の設定


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

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

フィールドを追加する

管理画面の「フィールド定義」で対象とフィールドセットを開き、「フィールドを追加」から型を選びます。型は「入力」「レイアウト」「フィールドグループ」「パターン」に分かれています。「キー」「ラベル」などを入力し、型ごとの設定や入力チェックは「高度な設定」で入力して、追加します。

行・タブの入れ物・タブ・アコーディオン・フィールドグループの中にも、フィールドを追加できます。追加したフィールドは、並び替えたり、箱に出し入れしたりできます。

基本の設定

項目

内容

既定値

入力例

キー

テンプレートでは {キー} で出力します。半角英字かアンダースコアで始め、半角英数字とアンダースコアで入力します(64 文字まで)。追加後は変更できません。

cf_

cf_event_date

ラベル

編集画面に出す項目名です。必須です。

—

開催日

フィールド型

入力欄の種類です。編集するときも、値を保存する型どうしなら変えられます。

選んだ型

日付

説明

入力欄に添える説明です。

空

イベントの開催日を選びます

必須入力

「任意」「保存時に必須」「公開時に必須」から選びます(後述)。

任意

公開時に必須

フィールドの設定フォーム(基本の設定)
フィールドの設定フォーム(基本の設定)

キーの欄に最初から入る cf_ は、エントリーの変数などと名前がぶつかるのを避けるための接頭辞です。システム設定 field_definition_key_prefix で変えられます。config.system.yaml に書きます(空にすると付きません)。

field_definition_key_prefix: my_

キーに使えない名前

field・id・status・code・title・link・date・start・end・page・order・serial・limit・offset・category_id・sub_category_id・tag・user_id・blog_id・entry_id・module_id・unit・keyword・csrf_token・formtoken・takeover・updatefield・__mounted はキーにできません。ACMS_POST で始まるキー(大文字と小文字を区別しません)も使えません。

必須入力

選択肢

確かめるとき

定義の値

任意

確かめません。

none

保存時に必須

保存するたびに確かめます(ゴミ箱へ移すときを除きます)。

save

公開時に必須

ステータスが公開の保存のときに確かめます。下書き・非公開では空のまま保存できます。エントリー以外の対象では「公開状態で必須」と表示します。

publish

「公開時に必須」は、編集画面の保存のほか、公開ボタン、一覧からのステータスの変更、エントリーの一括変更、CSV インポートでも確かめます。型「隠し値(hidden)」は必須にできません。

高度な設定

設定フォームの「高度な設定」を開くと、次の項目があります(型によって出る項目が変わります)。「config のキー」は、テーマの JSON で書くときの名前です(テーマでフィールド定義を宣言する)。

項目

config のキー

内容

既定値

入力例

初期値

defaultValue

新しく作るときに入れておく値です。ラジオボタンでは最初に選ぶ選択肢の値です。地図・アーカイブ画像・アーカイブファイルにはありません。

空

seminar

補足(ツールチップ)

tooltip

項目名の隣の「?」に出す補足です。

空

半角で入力します

入力欄の長さ

inputWidth

「おまかせ(種類に合わせる)」「ミニ」「小」「中」「大」「全幅」(mini・small・medium・large・full)。入力欄そのものの長さで、並べ方には影響しません。1 行の入力欄を持つ型だけにあります。

おまかせ

小

入力チェック

(validation.rules)

必須以外の入力チェックです(後述)。

なし

最大文字数 100

条件付き表示

(conditions)

ほかのフィールドの値によって、表示を切り替えます(後述)。

条件なし

種類が seminar のとき

権限・ロール別の表示

visibility

権限・ロールごとに、編集できるか・読み取り専用か・隠すかを決めます(後述)。

制限なし

投稿者は読み取り専用

非表示のときは値を保存しない

clearOnHide

条件付き表示で隠れている間は値を送らず、そのまま保存すると値は消えます。選ばなければ、隠れていても値を残します。

オフ

—

検索対象

(search)

キーワード検索の対象にするかどうかです。

オン(隠し値・地図・アーカイブ画像・アーカイブファイルはオフ)

—

列幅

width

1 行の中で占める割合です。「おまかせ(全幅。行の中では列数で割った幅)」か 100%・75%・66%・50%・33%・25%。50% を 2 つ続けると横に並びます(狭い画面では全幅)。

おまかせ

50%

有効にする

(status)

チェックを外すと、編集画面に出さず、保存時の必須・入力チェックも掛けません。

オン

—

「高度な設定」を開いた設定フォーム
「高度な設定」を開いた設定フォーム
「高度な設定」を開いた設定フォーム(続き)
「高度な設定」を開いた設定フォーム(続き)

入力チェック

必須以外の入力チェックは、「チェックする項目」「値」「エラーメッセージ」の組で追加します。編集画面で欄から離れたときと、保存するときに確かめ、満たさない値は保存できません。

選べる項目は、フォーム機能の入力チェックと同じ語彙から、型に合うものだけが出ます。

メソッド

画面の表示

「値」に入れるもの

入力例

選べる型

minlength

最小文字数

文字数(整数)

10

テキスト・テキストエリア・電話番号・メールアドレス・URL

maxlength

最大文字数

文字数(整数)

100

同上

min

下限値

数値

0

テキスト・テキストエリア・数値

max

上限値

数値

99.5

同上

regex

正規表現マッチ

正規表現(@ で囲まなければ自動で囲みます)

^[0-9]{3}-[0-9]{4}$

テキスト・テキストエリア・電話番号・メールアドレス・URL・日時

digits

数字チェック

なし

—

テキスト・テキストエリア・電話番号

decimal

小数チェック

小数部の桁数(整数)

2

テキスト・テキストエリア

email

メールアドレスチェック

なし

—

テキスト・テキストエリア

url

URLチェック

なし

—

テキスト・テキストエリア

equalTo

等価チェック

比べるフィールドのキー

cf_email

テキスト・テキストエリア

in

選択肢チェック

カンマ区切りの値

a,b,c

テキスト・テキストエリア

katakana

カタカナチェック

なし

—

テキスト・テキストエリア

hiragana

ひらがなチェック

なし

—

テキスト・テキストエリア

all_justChecked

選択数(一致)

数(整数)

3

複数の値を持つ型(チェックボックス・複数選択のセレクトボックス・メディアギャラリー・複数を選ぶ参照)

all_minChecked

最小選択数

数(整数)

1

同上

all_maxChecked

最大選択数

数(整数)

5

同上

all_unique

重複禁止

なし

—

同上

all_maxOccurrenceOf

値の出現回数(上限)

値:回数

main:1

同上

  • 数値・メールアドレス・URL・日付・時刻・日時・地図・選択肢の型は、入力チェックを付けなくても、型に合う値かを保存時にサーバーで確かめます(選択肢の型は、値が選択肢にあるか)。そのため、これらの型では同じ判定の入力チェック(数値の数字チェックなど)は選べません。

  • ラジオボタン・時刻・日付、メディア・参照(1 件)・地図・ブロックエディターなどには、選べる入力チェックがありません。

  • 正規表現マッチは、ブラウザで読めない正規表現((?i) など)だと、欄から離れたときには確かめず、保存するときにだけ確かめます。

サーバー側でも必ず確かめます

必須と入力チェックは、ブラウザから送られた指定ではなく、定義をもとにサーバーで確かめます。開発者ツールで入力欄を書き換えても、すり抜けられません。

条件付き表示

同じフィールドセットのほかのフィールドの値によって、このフィールドを出すか隠すかを決めます。グループ内の条件をすべて満たす(かつ)か、いずれかのグループを満たす(または)ときに表示します。

「高度な設定」の「条件付き表示」で、条件に使うフィールド・比べ方・値の組を追加します。同じグループの条件はすべて満たす(かつ)必要があり、別のグループを足すと、どれかを満たせば(または)表示します。選択肢を持つフィールドでは、値を選択肢から選べます。

条件の名前

画面の表示

意味

値の例

eq

と等しい

値が一致する

seminar

neq

と等しくない

値が一致しない

seminar

in

のいずれかと等しい

並べた値のどれかと一致する(1 行に 1 つ)

seminar と workshop

contains

を含む

値に文字列を含む

東京

empty

が空

値が空

—

notEmpty

が空でない

値が空でない

—

gt

より大きい(数値)

数値として大きい

100

lt

より小さい(数値)

数値として小さい

100

matches

が正規表現に一致する

正規表現に一致する

^https://

  • 隠れたフィールドには、必須と入力チェックを掛けません。

  • 隠れたフィールドの値は、既定では残します。「非表示のときは値を保存しない」を選ぶと、隠れたまま保存したときに値が消えます。

  • 条件が循環する(A の条件に B、B の条件に A を使う)ときは保存できません。

  • 正規表現の条件では、フラグ((?i) など)・\p{…}・後方参照・後読み・名前付きグループは使えません。

  • 型「ブロック」には条件付き表示を設定できません。

権限・ロール別の表示

「高度な設定」の「権限・ロール別の表示」で、権限(「編集者」「投稿者」「読者」)またはロールごとに、「編集できる」「読み取り専用」「表示しない(値は保持される)」を指定します。指定の無いユーザーの扱いは「指定のないユーザー」で選びます。

  • 管理者は常に編集できます。

  • 指定が重なるユーザーには、最も緩い指定(編集できる > 読み取り専用 > 表示しない)を使います。

  • 読み取り専用・表示しないのユーザーが値を送っても、サーバーは保存済みの値に戻します(新規作成なら空になります)。

  • フィールドグループの中のフィールドには設定できません。フィールドグループ(器)に設定すると、中のフィールドにも効きます。

  • 制限を付けたフィールドには、定義画面で「表示を制限」の印が付きます。

編集・複製・削除・型の変更

  • フィールドは、編集・複製・削除・無効化ができます。「有効にする」のチェックを外すと、編集画面への表示と、保存時のチェックの両方が止まります。

  • 削除しても、そのキーで保存済みの値は削除されません。同じキーで定義し直すと再び使えます。行(横並び)などの箱を削除すると、中のフィールドは 1 つ上の階層に移ります。

  • フィールド型は変えられますが、保存済みの値は変換されずに残ります。画像・ファイルなどの派生キー(@path など)の値は、新しい型では使いません。

  • キーは「キーを変更」で変えます(従来のカスタムフィールドとの併用と移行)。