カスタムフィールド

目次

カスタムフィールドの基本

カスタムフィールドとは

エントリーや、カテゴリー・ブログ・ユーザーに対して独自のデータを追加することができる機能です。追加したデータは表示や検索用のキーとして利用されます。例えば、ひとつの商品を紹介するエントリーに対して「値段・発売日・サイズ」などの情報をカスタムフィールドとして追加することで、商品情報のデータベースを作ることができます。

カスタムフィールドのタグの基本

カスタムフィールドはフォームタグのようにHTMLベースで書くことができます。値段を入れるカスタムフィールドを追加してみましょう。カスタムフィールドの変数は price にします。

<input type="text" name="price" value="{price}" />
<input type="hidden" name="field[]" value="price" />

HTMLベースなので入力画面を入力しやすいレイアウトできます。

カスタムフィールドでできること

カスタムフィールドは以下のような入力フォームが追加できます。

  • テキスト(テキスト、テキストエリア、チェックボックス、ラジオボタン、セレクトボックス)
  • 画像
  • ファイル
  • 地図(GoogleMaps)

カスタムフィールドの作成

カスタムフィールドはテキスト、テキストエリア、チェックボックス、ラジオボタン、セレクトなど用途に応じて作ることができ、お問い合わせフォームやエントリー作成画面、ブログ・カテゴリー・ユーザー・モジュールの管理画面で使います。
カスタムフィールドの記述について解説します。

テキストのカスタムフィールド

テキストを入力するカスタムフィールドを作ることができます。
サンプルHTML(カスタムフィールド変数名:furigana)

<tr>
  <th>ふりがな</th>
  <td>
    <input type="text" name="furigana" value="{furigana}" class="acms-form-width-3quarters" />
    <input type="hidden" name="field[]" value="furigana" />
  </td>
</tr>

テキストエリアのカスタムフィールド

テキストエリアを入力するカスタムフィールドを作ることができます。
サンプルHTML(カスタムフィールド変数名:inquiry)

<tr>
  <th>お問い合わせ内容</th>
  <td>
    <textarea name="inquiry" class="acms-form-width-3quarters">{inquiry}</textarea>
    <input type="hidden" name="field[]" value="inquiry" />
  </td>
</tr>

チェックボックスのカスタムフィールド

チェックボックスを入力するカスタムフィールドを作ることができます。 サンプルHTML(カスタムフィールド変数名:time)

<tr>
  <th>時間帯</th>
  <td>
    <label>
      <input type="checkbox" name="time[]" value="午前"{time:checked#午前} />
      午前
    </label>
    <label>
      <input type="checkbox" name="time[]" value="午後"{time:checked#午後} />
      午後
    </label>
    <input type="hidden" name="field[]" value="time" />
  </td>
</tr>

ラジオボタンのカスタムフィールド

ラジオボタンを入力するカスタムフィールドを作ることができます。 サンプルHTML(カスタムフィールド変数名:gender)

<tr>
  <th>性別</th>
  <td>
    <label><input type="radio" name="gender" value="男"{gender:checked#男} />男</label>
    <label><input type="radio" name="gender" value="女"{gender:checked#女} />女</label>
    <input type="hidden" name="field[]" value="gender" />
  </td>
</tr>

セレクトのカスタムフィールド

セレクトボックスを入力するカスタムフィールドを作ることができます。 サンプルHTML(カスタムフィールド変数名:type)

<tr>
  <th>ご用件</th>
  <td>
    <select name="type">
      <option value=""></option>
      <option value="ご質問"{type:selected#ご質問}>ご質問</option>
      <option value="資料請求"{type:selected#資料請求}>資料請求</option>
      <option value="その他"{type:selected#その他}>その他</option>
    </select>
    <input type="hidden" name="field[]" value="type" />
  </td>
</tr>

ブログのカスタムフィールド

ブログの管理画面にカスタムフィールドを作って、独自の情報を持たせることができます。テキスト、画像、ファイルなどブログ毎に項目が作れます。


ブログのカスタムフィールド画面

ブログのカスタムフィールド画面


ブログのカスタムフィールドはブログ管理のカスタム設定タブにあります。カスタムフィールドを追加するには以下のファイルを利用中のテーマフォルダに置いてください。

/themes/利用中のテーマ/admin/blog/field.html

ブログのカスタムフィールドを作る

/themes/利用中のテーマ/admin/blog/field.html にサイトの説明を入力するカスタムフィールドを追加してみましょう。

<input type="text" name="siteDescription" value="{siteDescription}" class="acms-form-width-full" />
<input type="hidden" name="field[]" value="siteDescription" />

サイトに表示させる

ブログのカスタムフィールドはBlog_Fieldモジュール、Entry_BodyやEntry_SummaryモジュールのblogFieldブロック内で使うことができます。

Blog_Fieldモジュールで表示

<!-- BEGIN_MODULE Blog_Field -->
<p>{siteDescription}</p>
<!-- END_MODULE Blog_Field -->

Entry_BodyやEntry_SummaryモジュールのblogFieldブロック内で表示

モジュールIDの設定して、entry:loop内にblogFieldブロックを記述してください。

<!-- BEGIN_MODULE Entry_Summary id="testID" -->
<!-- BEGIN unit:loop -->
<!-- BEGIN entry:loop -->

<!-- BEGIN blogField -->
<p>{siteDescription}</p>
<!-- END blogField -->

<!-- END entry:loop -->
<!-- END unit:loop -->
<!-- END_MODULE Entry_Summary -->

Entry_BodyやEntry_Summaryモジュールでブログのカスタムフィールドの情報を出すときはモジュールIDの表示設定にカスタムフィールド ブログフィールドにチェックをしてください。


モジュールのブログフィールド出力設定

モジュールのブログフィールド出力設定

カテゴリーのカスタムフィールド

カテゴリーの管理画面にカスタムフィールドを作って、独自の情報を持たせることができます。テキスト、画像、ファイル、地図などカテゴリー毎に項目が作れます。


カテゴリーのカスタムフィールド画面

カテゴリーのカスタムフィールド画面


カテゴリーのカスタムフィールドはカテゴリー管理のカスタム設定タブにあります。カスタムフィールドを追加するには以下のファイルを利用中のテーマフォルダに置いてください。

/themes/利用中のテーマ/admin/category/field.html

カテゴリーのカスタムフィールドを作る

/themes/利用中のテーマ/admin/category/field.html にページのキーワードを入力するカスタムフィールドを追加してみましょう。

<input type="text" name="category_meta_keywords" value="{category_meta_keywords}" class="acms-form-width-full" />
<input type="hidden" name="field[]" value="category_meta_keywords" />

サイトに表示させる

カテゴリーのカスタムフィールドはCategory_Fieldモジュール、Category_ListやCategory_EntryList、Entry_BodyやEntry_SummaryモジュールのcategoryFieldブロック内で使うことができます。

Category_Fieldモジュールで表示

<!-- BEGIN_MODULE Category_Field -->
<p>{category_meta_keywords}</p>
<!-- END_MODULE Category_Field -->

Category_ListやCategory_EntryListモジュールで表示

category:loop内にカテゴリーのカスタムフィールドを書きます。

<!-- BEGIN_MODULE Category_List -->
<!-- BEGIN category:loop -->

<!-- BEGIN ul#front -->
<ul><!-- END ul#front --><!-- BEGIN li#front -->
	<li><!-- END li#front --><!-- BEGIN category:veil -->
		<a href="{url}">{name} - {category_meta_keywords}</a><!-- END category:veil --><!-- BEGIN li#rear -->
	</li><!-- END li#rear --><!-- BEGIN ul#rear -->
</ul><!-- END ul#rear -->

<!-- END category:loop -->
<!-- END_MODULE Category_List -->

Entry_BodyやEntry_SummaryモジュールのcategoryFieldブロック内で表示

モジュールIDの設定して、entry:loop内にcategoryFieldブロックを記述してください。

<!-- BEGIN_MODULE Entry_Summary id="testID" -->
<!-- BEGIN unit:loop -->
<!-- BEGIN entry:loop -->
     
<!-- BEGIN categoryField -->
<p>{category_meta_keywords}</p>
<!-- END categoryField -->
     
<!-- END entry:loop -->
<!-- END unit:loop -->
<!-- END_MODULE Entry_Summary -->

Entry_BodyやEntry_Summaryモジュールでカテゴリーのカスタムフィールドの情報を出すときはモジュールIDの表示設定にカスタムフィールド カテゴリーフィールドにチェックをしてください。


モジュールのカテゴリーカスタムフィールド出力設定

モジュールのカテゴリーカスタムフィールド出力設定

エントリーのカスタムフィールド

エントリーの作成画面にカスタムフィールドを作って、独自の情報を持たせることができます。テキスト、画像、ファイル、地図などエントリー毎に項目が作れます。


エントリーのカスタムフィールド画面

エントリーのカスタムフィールド画面


エントリーのカスタムフィールドはエントリー作成画面にあります。カスタムフィールドを追加するには以下のファイルを利用中のテーマフォルダに置いてください。

タイトルやカテゴリーの下にカスタムフィールドを表示したい場合

/themes/利用中のテーマ/admin/entry/field.html

ユニットの下にカスタムフィールドを表示したい場合

/themes/利用中のテーマ/admin/entry/field_foot.html

エントリーのカスタムフィールドを作る

/themes/利用中のテーマ/admin/entry/field.html にエントリーをピックアップするチェックボックスのカスタムフィールドを追加してみましょう。

<label class="acms-form-checkbox"><input type="checkbox" name="pickup[]" value="true"{pickup:checked#true} /><i class="acms-ico-checkbox"></i> ピックアップ</label>
<input type="hidden" name="field[]" value="pickup" />

サイトに表示させる

エントリーのカスタムフィールドはEntry_Fieldモジュール、Category_EntryListやCategory_EntrySummary、Entry系モジュールのentry:loop内で使うことができます。

Entry_Fieldモジュールで表示

<!-- BEGIN_MODULE Entry_Field -->
<p>{pickup}</p>
<!-- END_MODULE Entry_Field -->

Category_EntryListやCategory_EntrySummaryモジュールで表示

entry:loop内にエントリーのカスタムフィールドを書きます。

<!-- BEGIN_MODULE Category_EntryList -->
<!-- BEGIN categoryEntryList:loop --><!-- BEGIN categoryUl#front -->
<ul class="txtListMenu"><!-- END categoryUl#front --><!-- BEGIN category:loop -->
	<li><a href="{categoryUrl}">{categoryName}</a><!-- BEGIN entry:veil -->
		<ul class="txtListMenu"><!-- BEGIN entry:loop -->
			<li><a href="{entryUrl}">{entryTitle} {pickup}</a></li><!-- END entry:loop -->
		</ul><!-- END entry:veil --><!-- END category:loop --><!-- BEGIN categoryLi#rear -->
	</li><!-- END categoryLi#rear --><!-- BEGIN categoryUl#rear -->
</ul><!-- END categoryUl#rear --><!-- END categoryEntryList:loop -->
<!-- END_MODULE Category_EntryList -->

Entry系モジュールで表示

モジュールIDの設定して、entry:loop内にエントリーカスタムフィールドを記述してください。

<!-- BEGIN_MODULE Entry_Summary id="testID" -->
<!-- BEGIN unit:loop -->
<!-- BEGIN entry:loop -->
     
<!-- BEGIN pickup:touch#true -->pickupされています<!-- END pickup:touch#true -->
     
<!-- END entry:loop -->
<!-- END unit:loop -->
<!-- END_MODULE Entry_Summary -->

Entry系モジュールでエントリーのカスタムフィールドの情報を出すときはモジュールIDの表示設定にカスタムフィールド エントリーフィールドにチェックをしてください。


モジュールのエントリーフィールド出力設定

モジュールのエントリーフィールド出力設定

ユーザーのカスタムフィールド

ユーザーの管理画面にカスタムフィールドを作って、独自の情報を持たせることができます。テキスト、画像、ファイル、地図などユーザー毎に項目が作れます。


ユーザーフィールド編集画面

ユーザーフィールド編集画面


ユーザーのカスタムフィールドはユーザー管理のカスタム設定タブにあります。カスタムフィールドを追加するには以下のファイルを利用中のテーマフォルダに置いてください。

/themes/利用中のテーマ/admin/user/field.html

ユーザーのカスタムフィールドを作る

/themes/利用中のテーマ/admin/user/field.html にユーザーの郵便番号を入力するカスタムフィールドを追加してみましょう。

〒 <input type="text" name="zip" value="{zip}" id="zip" class="acms-form-width-mini" size="14" />
<input type="hidden" name="field[]" value="zip" />

サイトに表示させる

ユーザーのカスタムフィールドはUser_Fieldモジュール、User_ProfileやUser_Search、Entry_BodyやEntry_SummaryモジュールのuserFieldブロック内で使うことができます。

User_Fieldモジュールで表示

<!-- BEGIN_MODULE User_Field -->
<p>{zip}</p>
<!-- END_MODULE User_Field -->

User_ProfileやUser_Searchモジュールで表示

user:loop内にユーザーのカスタムフィールドを書きます。

<!-- BEGIN_MODULE User_Profile -->
<!-- BEGIN user:loop -->

<p>{zip}</p>

<!-- END user:loop -->
<!-- END_MODULE User_Profile -->

Entry_BodyやEntry_SummaryモジュールのuserFieldブロック内で表示

モジュールIDの設定して、entry:loop内にuserFieldブロックを記述してください。

<!-- BEGIN_MODULE Entry_Summary id="testID" -->
<!-- BEGIN unit:loop -->
<!-- BEGIN entry:loop -->
     
<!-- BEGIN userField -->
<p>{zip}</p>
<!-- END userField -->
     
<!-- END entry:loop -->
<!-- END unit:loop -->
<!-- END_MODULE Entry_Summary -->

Entry_BodyやEntry_Summaryモジュールでユーザーのカスタムフィールドの情報を出すときはモジュールIDの表示設定にカスタムフィールド ユーザーフィールドにチェックをしてください。


モジュールのユーザーフィールド出力設定

モジュールのユーザーフィールド出力設定

モジュールのカスタムフィールド

モジュールの管理画面にカスタムフィールドを作って、独自の情報を持たせることができます。テキスト、画像、ファイル、地図などモジュール毎に項目が作れます。


モジュールフィールドの編集画面

モジュールフィールドの編集画面


モジュールのカスタムフィールドは、モジュールID一覧>モジュールIDの変更の順に移動したページのカスタム設定のタブにあります。カスタムフィールドを追加するには以下のファイルを利用中のテーマフォルダに置いてください。

/themes/利用中のテーマ/admin/module/field.html

モジュールのカスタムフィールドを作る

/themes/利用中のテーマ/admin/module/field.html に見出しを入力するカスタムフィールドを追加してみましょう。

<input type="text" name="module_heading" value="{module_heading}" class="acms-admin-form-width-3quarters" />
<input type="hidden" name="field[]" value="module_heading" />

サイトに表示させる

モジュールのカスタムフィールドはモジュールIDが作成できるモジュールのmoduleFieldブロック内で使用できます。

moduleFieldブロックで表示

<!-- BEGIN_MODULE Entry_Summary id="testID" -->

<!-- BEGIN moduleField -->
<h2>{module_heading}</h2>
<!-- END moduleField -->

<!-- BEGIN unit:loop -->
<!-- BEGIN entry:loop -->
    ...
<!-- END entry:loop -->
<!-- END unit:loop -->

<!-- END_MODULE Entry_Summary -->

モジュールのカスタムフィールドをご使用の際は、使用したいモジュールIDのカスタムフィールドの項目をチェックしてください。


共通の項目という見出しの後にあるカスタムフィールドの項目をチェックする

共通の項目という見出しの後にあるカスタムフィールドの項目をチェックする

カスタムフィールドグループ

カスタムフィールドグループとは、単体の項目であるカスタムフィールドを複数まとめて取り扱うことができる機能です。カスタムフィールドの項目を追加したり、削除したりすることができます。
カスタムフィールドグループはカスタムフィールドと同じように画像やテキストのカスタムフィールドを組み合わせて使えます。


カスタムフィールドグループのサンプル

カスタムフィールドグループのサンプル


例)画像とテキスト、テキストエリアを組み合わせたカスタムフィールドグループです。

<table class="js-fieldgroup-sortable">
  <!-- BEGIN bfd_field_unit_group:loop -->
  <tr class="sortable-item">
    <td class="item-handle">
      <div class="acms-form-group"><span class="acms-icon acms-icon-sort2"></span></div>
      <a class="item-delete acms-btn-admin acms-btn-admin-danger block-level" href="#" onclick="return false;">削除</a>
    </td>
    <td>
      <table class="nestTable">
        <tr>
          <th>小画像</th>
          <th>小見出しとURL</th>
          <th>小概要</th>
        </tr>
        <tr>
          <td>
              <!-- BEGIN bfd_field_unit_image:veil -->
              <img src="%{ARCHIVES_DIR}{bfd_field_unit_image@path}" />
              <!-- END bfd_field_unit_image:veil -->
              <br />
              <label><input type="checkbox" name="bfd_field_unit_image@edit[{i}]" value="delete" />削除</label>
              <input type="file" name="bfd_field_unit_image[{i}]" class="acms-form-width-full" />
              <input type="hidden" name="bfd_field_unit_image@width[{i}]" value="200" />
            </td>
            <td>
              <div class="acms-form-group">
                <input type="text" name="bfd_field_unit_lead[{i}]" value="{bfd_field_unit_lead}" class="acms-form-width-full" />
              </div>
              <input type="text" name="bfd_field_unit_url[{i}]" value="{bfd_field_unit_url}" class="acms-form-width-full" />
            </td>
            <td>
              <textarea name="bfd_field_unit_summary[{i}]" class="acms-form-width-full" >{bfd_field_unit_summary}</textarea>
            </td>
        </tr>
      </table>
    </td>
  </tr>
    <!-- END bfd_field_unit_group:loop -->
    <tr class="sortable-item item-template">
      <td class="item-handle">
        <span class="acms-icon acms-icon-sort2"></span>
      </td>
      <td>
        <table>
          <tr>
            <th>小画像</th>
            <th>小見出しとURL</th>
            <th>小概要</th>
          </tr>
          <tr>
            <td>
              <input type="file" name="bfd_field_unit_image[]" class="acms-form-width-full" />
              <input type="hidden" name="bfd_field_unit_image@width[]" value="200" />
            </td>
            <td>
              <div class="acms-form-group">
                <input type="text" name="bfd_field_unit_lead[]" value="" class="acms-form-width-full" />
              </div>
              <input type="text" name="bfd_field_unit_url[]" value="" class="acms-form-width-full" />
            </td>
            <td>
              <textarea name="bfd_field_unit_summary[]" class="acms-form-width-full" ></textarea>
            </td>
          </tr>
        </table>
      <input type="hidden" name="bfd_field_unit_image@old[{i}]" value="{bfd_field_unit_image@path}" />
    </td>
  </tr>
  <tfoot>
      <tr>
      <td colspan="3">
        <input type="button" class="item-insert acms-btn-admin" value="項目を追加する" />
      </td>
    </tr>
  </tfoot>
</table>

<input type="hidden" name="@bfd_field_unit_group[]" value="bfd_field_unit_lead" />
<input type="hidden" name="field[]" value="bfd_field_unit_lead" />
<input type="hidden" name="@bfd_field_unit_group[]" value="bfd_field_unit_url" />
<input type="hidden" name="field[]" value="bfd_field_unit_url" />
<input type="hidden" name="@bfd_field_unit_group[]" value="bfd_field_unit_summary" />
<input type="hidden" name="field[]" value="bfd_field_unit_summary" />

<input type="hidden" name="bfd_field_unit_image:extension" value="image" />
<input type="hidden" name="@bfd_field_unit_group[]" value="bfd_field_unit_image@path" />
<input type="hidden" name="@bfd_field_unit_group[]" value="bfd_field_unit_image@x" />
<input type="hidden" name="@bfd_field_unit_group[]" value="bfd_field_unit_image@y" />
<input type="hidden" name="@bfd_field_unit_group[]" value="bfd_field_unit_image@edit" />
<input type="hidden" name="@bfd_field_unit_group[]" value="bfd_field_unit_image@old" />
<input type="hidden" name="field[]" value="bfd_field_unit_image" />
<input type="hidden" name="field[]" value="@bfd_field_unit_group" />

カスタムフィールドグループ内で使用可能なclass属性

カスタムフィールドグループ内では、いくつかの特殊なclass属性の記述があります。これらは、実際にブラウザ上で表示される際に機能します。

js-fieldgroup-sortable

このclass属性が適用されている範囲内で、カスタムフィールドグループが使用できます。 ひな形となり、この要素の内容が追加されます。

item-handle

このclass属性が記述されている要素が、順番を変更する時に「つかむ(ドラッグする)」部分になります。js-fieldgroup-sortable内で使用可能です。

item-delete

このclass属性が記述されている要素で、該当するカスタムフィールドグループが削除できます。js-fieldgroup-sortable内で使用可能です。

item-max

このclass属性が記述されている要素のvalueにある値がカスタムフィールドグループに挿入できる項目の最大数となります。例えば以下のソースコードで、7以上の項目を追加しようとすると警告文が表示されます。js-fieldgroup-sortable内で使用可能です。

<input type="hidden" class="item-max" value="6" />


例で使用したカスタムフィールドの解説

カスタムフィールドの定義

カスタムフィールドのグループ名(@bfd_field_unit_group)とカスタムフィールド変数名(bfd_field_unit_lead)をセットで定義します。

<input type="hidden" name="@カスタムフィールドのグループ名[]" value="カスタムフィールド変数名" />
<input type="hidden" name="field[]" value="カスタムフィールド変数名" />

カスタムフィールドのグループ名(@bfd_field_unit_group)はカスタムフィールドのグループ名を記述しています。

<input type="hidden" name="field[]" value="@カスタムフィールドのグループ名" />

テンプレートに表示する

エントリーカスタムフィールドで作成した場合は、Entry系モジュールのentry:loop内にカスタムフィールドグループを記述してください。

<!-- BEGIN bfd_field_unit_group:loop -->
<div style="width:200px; float:left; margin-right:20px;">
<!-- BEGIN bfd_field_unit_image:veil -->
<img src="%{ARCHIVES_DIR}{bfd_field_unit_image@path}" alt="" width="200">
<!-- END bfd_field_unit_image:veil -->
<h3><a href="%{HTTP_ROOT}{bfd_field_unit_url}">{bfd_field_unit_lead}</a></h3>
<p>{bfd_field_unit_summary}</p>
</div>
<!-- END bfd_field_unit_group:loop -->


上記のような bfd_field_unit_group:loop のブロック中に変数を書くことで複数件のデータを表示させるのがカスタムフィールドグループの利用としては一般的ですが、ループさせずに 2番目だけ 表示させたいという場合には、{bfd_field_unit_lead[1]} のような記述でも「小見出し2です」を表示させることが可能です。(配列の添字は 0 から始まります)

カスタムフィールドメーカーの使い方

管理画面のコンフィグ管理のところにガイドライン/ツール「カスタムフィールドメーカー」というページがあります。


カスタムフィールドメーカーのメニュー

カスタムフィールドメーカーのメニュー


カスタムフィールドメーカーではカスタムフィールドを毎回どこからからコピペして書き換えたりしなくてもラベルや値、サイズなど入力していくだけカスタムフィールドのHTMLが作れてしまう便利な機能になります。カスタムフィールドではテキストや画像などさまざまなカスタムフィールドを組み合わせることができます。

  • テキスト
  • セレクト
  • ラジオ
  • チェックボックス
  • テキストエリア
  • 画像
  • カスタムフィールドグループ
  • カスタムユニット

カスタムフィールドの作り方

  1. typeとタイトル、フィールド名を入力します。
  2. それぞれの項目に応じた項目に対して、値を入力して[生成]ボタンを押すとカスタムフィールドのHTMLが生成されます

カスタムフィールド全体像

カスタムフィールド全体像


続けてtype セレクトに変更しタイトル、name属性、option要素(label・value)を入力して[生成]ボタンを押すとテキストの下にセレクトのカスタムフィールドが生成されます。


カスタムフィールド入力例

カスタムフィールド入力例


カスタムフィールド生成例

カスタムフィールド生成例


画像のカスタムフィールドを生成

タイトル、name要素、通常サイズ、altの入力、tinyサイズ、largeサイズ、squareサイズなど細やかに設定することができます。


画像のカスタムフィールド生成例

画像のカスタムフィールド生成例


また、「フロント側のリサイズ機能を使用する」という項目にチェックを入れることで、画像のブラウザ上でのリサイズを可能にするソースコードを生成します。 これを使うことで、通常だとそのままアップロードができないサイズの画像もアップロードできるようになります。例えば、デジタルカメラで撮影したような容量の大きい画像をブラウザ上でリサイズしてサーバーにアップロードすることができるということです。

カスタムフィールドグループの作り方

まずは、下の図のように、「カスタムフィールド」、「カスタムフィールドグループ」、「カスタムユニット」からカスタムフィールドグループを選択します。


カスタムフィールドグループの選択

カスタムフィールドグループの選択


  1. groupタイトルとgroup名を入力
  2. テキスト、セレクト、ラジオ、チェックボックス、テキストエリア、画像を選択
  3. 要素に合わしたタイトル、name属性、値などを入力
  4. [追加]ボタンを押すと要素が追加されます
  5. 2の手順に戻り、要素をまた選択してカスタムフィールドを追加してください
  6. 最後に[生成]ボタンを押してください

カスタムフィールドグループ入力例

カスタムフィールドグループ入力例


カスタムユニットの作り方

まずは、下の図のように、「カスタムフィールド」、「カスタムフィールドグループ」、「カスタムユニット」からカスタムユニットを選択します。


カスタムユニット選択

カスタムユニット選択


あとは、カスタムフィールドの作り方と同じです。 typeとタイトル、フィールド名を入力します。 それぞれの項目に応じた項目に対して、値を入力して[生成]ボタンを押すとカスタムフィールドのHTMLが生成されます

その他、カスタムフィールドメーカーの便利な機能

他にもカスタムフィールドメーカーには下記のような便利な機能が用意されています。

  • フィールドに対する「変換・入力チェック」用ソースコードの生成
  • 生成されたコードのプレビュー機能
  • フィールドの「出力用ソース」生成機能
  • 生成コードに対する管理画面用クラスの付与

フィールドに対する「変換・入力チェック」用ソースコードの生成

「オプション」という項目をクリックすると、下の図のように変換と、入力チェックのためのフィールドが出現します。


変換・入力チェック画面

変換・入力チェック画面


はじめに、「変換」ですが、これを使うことで例えば「大文字」で登録されたアルファベットを「小文字」に変換したりするためのソースコードを生成可能です。「参照」と書かれたボタンを押していただくと下の図のようにモーダルウィンドウが現れますので、その中から変換したい項目を選択してください。変換のフィールドには複数の値を登録することも可能です。


コンバーター参照

コンバーター参照

つづいて「入力チェック」ですが、こちらは入力された値を指定した条件でチェックできます。もし条件に沿わない値が入力された場合、再度入力を促すことができます。 下の例は、あるフィールドに対して値が入力されていない場合に、「値を入力してください」というメッセージを表示する際のサンプルです。


入力チェックのサンプル

入力チェックのサンプル


その他にも、文字数チェックや、URLチェックなど様々な条件で値を判定することができます。「値」の欄には文字数チェックにおいて最大文字数を入れたり、正規表現マッチで、正規表現を入れたりする際に使用します。

生成されたコードのプレビュー機能

また、下の図のように、「入力用ソース」、「プレビュー」、「出力用ソース」と書かれたタブのあるボックスから、プレビューを選択していただくと、下の図のように実際に出力されたソースがどのような見た目になるのかを確認することができます。


カスタムフィールドのプレビュー

カスタムフィールドのプレビュー


フィールドの「出力用ソース」生成機能

これは、カスタムフィールドに入力された値の結果をテーブル形式で表示したい時に使用します。 例えばお問い合わせのフォームにて、入力された値をお客様に確認してもらうためのソースコードとして役にたちます。


出力用ソース

出力用ソース


生成コードに対する管理画面用クラスの付与

下の図のように、「acms-admin.cssを使用する」という項目にチェックを入れることで、a-blog cmsの管理画面で使用されているクラスが施されたソースコードを生成できます。 これにチェックを入れていないと、全くクラスの施されていないソースコードが生成されます。


出力用ソースのオプション

出力用ソースのオプション


デベロッパーサイトのカスタムフィールドメーカーを使用する

本デベロッパーサイトでもカスタムフィールドメーカーを使用することができます。
下の図のように、使い方はa-blog cmsに搭載されているカスタムフィールドメーカーと同じです。


developerサイトのカスタムフィールドメーカー

developerサイトのカスタムフィールドメーカー


本デベロッパーサイトのドキュメントページの、リファレンスのカスタムフィールドメーカーを選択すると移動することができます。是非サイト政策にお役立てください。


カスタムフィールドメーカの場所

カスタムフィールドメーカの場所

テキスト入力にインラインエディターを使用する

すでにテキストユニットに導入されているインラインエディタですが、このインターフェースはカスタマイズ次第でブログやカテゴリー、エントリーなどのカスタムフィールドとしても利用可能です。ここではその方法について、登録側(管理画面)と表示側に分けてご紹介します。

管理画面の記述

以下が、インラインエディターが実装された、カスタムフィールドのサンプルHTMLになります。

<table class="acms-admin-table-admin-edit">
  <tr>
    <th>インラインエディター</th>
    <td>
      <textarea name="sample_text" class="js-lite-editor-field acms-admin-form-width-full">{sample_text}</textarea>
      <input type="hidden" name="field[]" value="sample_text" />
    </td>
  </tr>
</table>

表示側の記述

表示したいインラインエディターの変数がsample_textであった場合、以下のように記述します。エントリーのカスタムフィールドで作成した場合はEntry系モジュールのentry:loop内に記述してください。校正せず、そのままのデータを出力する校正オプション[raw]を記述してください。

{sample_text}[raw]

ボタンの位置、クラス名、ボタンのオプションの変更

テキストユニットで導入されているインラインエディターとはオプションの指定方法が異なります。
a-blog cms Ver.2.11.40 の時点で LiteEditorFieldConf の設定がデフォルトで空になっているため、カスタムフィールドでLiteEditorを使用する場合は適用しているテーマ内にJavaScriptファイルを別途作成して設定ください。
ACMS.Config.LiteEditorFieldConf.xxxという記述で設定を下記のように適用します。

ACMS.Ready(function(){
  ACMS.Config.LiteEditorFieldConf.btnPosition = 'bottom';
  ACMS.Config.LiteEditorFieldConf.classNames = {
    LiteEditor: 'entryFormLiteEditor',
    LiteEditorBtnGroup: 'acms-admin-btn-group acms-admin-btn-group-inline',
    LiteEditorBtn: 'acms-admin-btn',
    LiteEditorBtnActive: 'acms-admin-btn acms-admin-btn-active',
    LiteEditorBtnClose: '',
    LiteEditorTooltipInput: 'acms-admin-form-width-full'
  };
  ACMS.Config.LiteEditorFieldConf.btnOptions = [
   { label: 'リンク', tag: 'a', className: '', sampleText: 'リンクテキスト' },
   { label: '強調', tag: 'em', className: '', sampleText: ' ' },
   { label: '重要', tag: 'strong', className: '', sampleText: ' ' }
  ];
});

LiteEditorのデフォルトボタンをそのまま維持したい場合はbtnOptionsを下記のように指定します。

ACMS.Config.LiteEditorFieldConf.btnOptions = [
  { label: '<span class="lite-editor-font-back"></span>', action: 'undo', group: 'action' },
  { label: '<span class="lite-editor-font-go"></span>', action: 'redo', group: 'action' },
  { label: '<span class="lite-editor-font-link"></span>', tag: 'a', className: '', group: 'mark' },
  { label: '<span class="lite-editor-font-bold"></span>', tag: 'strong', className: '', group: 'mark' },
  { label: '<span class="lite-editor-font-italic"></span>', tag: 'i', className: '', group: 'mark' },
  { label: '<span class="lite-editor-font-underline"></span>', tag: 'u', className: '', group: 'mark' }
];

テーブル用の入力インターフェースを使用する

Ver.2.7.0 から使えるようになったテーブルユニットですが、下の図のように、このインターフェースはカスタマイズ次第でブログやカテゴリー、エントリーのカスタムフィールドとしても利用可能です。ここではその方法について、登録側(管理画面)と表示側に分けてご紹介します。



登録側(管理画面)の記述

以下が、テーブル編集のインターフェースが実装された、カスタムフィールドのサンプルHTMLになります。 IFブロックのELSEの方の記述に、まだカスタムフィールドが保存されていない場合、初期状態で表示したいテーブルのHTMLを記述します。

<div class="js-editable-table-field" style="background-color:#eee;padding:10px;">
  <div class="js-editable-table">
    <!-- BEGIN_IF [{table}[delnl]/nem] -->
    {table}[raw]
    <!-- ELSE -->
    <table>
      <tr>
        <th>サンプル</th>
        <th>サンプル</th>
	  </tr>
      <tr>
        <td>サンプル</td>
        <td>サンプル</td>
      </tr>
    </table>
    <!-- END_IF -->
    <input type="hidden" class="js-editable-table-dest" value="{table}" name="table">
    <input type="hidden" name="field[]" value="table">
  </div>
</div>

表側の記述

表示したいテーブルが、{table} という変数の場合は以下のように記述します。エントリーのカスタムフィールドで作成した場合はEntry系モジュールのentry:loop内に記述してください。 また、HTMLをそのまま出力したいので校正オプションである[raw]をつける必要があります。ご注意ください。

{table}[raw]

メディアを使用する

メディアを利用したカスタムフィールドとは

Ver.2.10からメディアを利用したカスタムフィールドを作れるようになりました。メディアのカスタムフィールドを使うとメディア管理に登録されている画像やファイルをカスタムフィールドとして登録することができます。

a-blog cmsに標準で梱包されているsiteテーマにもブログのカスタムフィールドにメディアのカスタムフィールドが組み込まれています。


メディア選択

「メディア選択」をクリックするとメディア一覧から画像もしくはファイルを選択するモーダルウィンドウが出現します。


メディアアップロード

またカスタムフィールドより「アップロード」ボタンをクリックするとそこから新たにメディアを登録するためのモーダルウィンドウが出現します。


メディアのカスタムフィールドからもメディアユニットのように複数ファイルアップロード可能ですが、カスタムフィールドとして登録されるファイルは初めの一個だけになります。

メディア編集

また「メディア編集ボタン」をクリックすることで、メディアのカスタムフィールドから直接登録されたメディアを編集することができます。ただし、このメディアが他の場所でも使われている可能性があるので十分注意して編集してください。


メディア削除

また、カスタムフィールドに登録してあるメディアは「削除」ボタンをクリックすることでカスタムフィールドへの登録を解除できます。メディアに登録されたファイルは削除されません。

カスタムフィールドの記述方法

メディアのカスタムフィールドは簡単なHTMLを記述するだけで作成可能です。下はメディアのカスタムフィールドのサンプルコードになります。

<tr class="js-media-field">
  <th>サイト ロゴ
    <i class="acms-admin-icon-tooltip js-acms-tooltip" data-acms-tooltip="サイトのロゴ画像を設定します。"></i>
  </th>
  <td>
    <div>
      <!-- BEGIN_IF [{site_logo@thumbnail}/nem] -->
      <img src="{site_logo@thumbnail}" class="acms-admin-img-responsive js-preview" alt="{site_logo@alt}" />
      <!-- ELSE -->
      <img src="" style="display:none" class="acms-admin-img-responsive js-preview" />
      <!-- END_IF -->
    </div>
    <div class="acms-admin-margin-top-mini">
      <button type="button" class="js-insert acms-admin-btn">メディア選択</button>
      <button type="button" class="js-insert acms-admin-btn" data-mode="upload">アップロード</button>
      <button type="button" class="js-edit acms-admin-btn">メディア編集</button>
      <button type="button" class="js-remove acms-admin-btn acms-admin-btn-danger">削除</button>
    </div>
    <input type="hidden" name="site_logo" value="{site_logo}" class="js-value" />
    <input type="hidden" name="field[]" value="site_logo" />
    <input type="hidden" name="site_logo:extension" value="media" />
  </td>
</tr>

メディアのカスタムフィールドを利用したい領域に js-media-field というクラスを追加します。その後その領域内で、メディア選択ボタンには、js-insert、メディア編集ボタンにはjs-edit、削除ボタンにはjs-removeというクラスを付与します。またメディアの選択結果をプレビューしたい場合はimg要素に js-previewというクラスを付与します。アップロードボタンも選択ボタンと同じく、js-insertクラスを付与しますが、data-mode属性をuploadにする必要があります。さらに、アップロードしたい画像のタイプを制限したい場合は、data-type属性を利用します。data-type="image"にすると画像のみアップロード可能に、また、data-type="file"とするとファイルのみアップロード可能になります。

カスタムフィールドメーカーの利用

Ver.2.10よりカスタムフィールドメーカーからメディア用のカスタムフィールドもHTML出力できるようになっています。記述量が多いのでこちらで設定する方が間違いが少ないのでオススメです。


こちらのカスタムフィールドメーカーはdeveloperサイトからもご利用いただけます。

ファイルをアップロードする

ファイルをアップロードするカスタムフィールドついて詳しく説明します。
以下で説明しているファイルのカスタムフィールドは、ソースコードの生成はカスタムフィールドメーカーで簡単に作成できます。

ファイルをアップロードするカスタムフィールドの作成

例)PDFファイルをアップロードするカスタムフィールド(フィールド名:pdffile)

<!-- BEGIN pdffile@path:veil -->
<input type="hidden" name="pdffile@old" value="{pdffile@path}" />
<input type="hidden" name="pdffile@secret" value="{pdffile@secret}" />
<input type="hidden" name="pdffile@baseName" value="{pdffile@baseName}" />
<input type="hidden" name="pdffile@fileSize" value="{pdffile@fileSize}" />

<label for="input-checkbox-pdffile@edit">
<input type="checkbox" name="pdffile@edit" value="delete" id="input-checkbox-pdffile@edit" /> 削除
</label>
<a href="%{HTTP_ARCHIVES_DIR}{pdffile@path}"><img src="/images/fileicon/pdf.gif" width="64" height="64" alt="zip" /></a><!-- END pdffile@path:veil -->
<input type="file" name="pdffile" />
<input type="hidden" name="field[]" value="pdffile" />
<input type="hidden" name="pdffile:extension" value="file" />
<input type="hidden" name="pdffile@extension" value="pdf" />
<input type="hidden" name="pdffile@filename" value="pdf/example.pdf" />

各記述の説明

2行目:ファイルがアップロードされなかった場合に既存のアップロードされているファイルの情報を送信する記述【必須】

<input type="hidden" name="フィールド名@old" value="{フィールド名@path}" />

4行目:システムのファイル名を表示するための記述【任意】(v1.4.2から)

<input type="hidden" name="pdffile@baseName" value="{pdffile@baseName}" />

5行目:ファイルサイズを自動で取得するための記述【任意】(v1.4.2から)

<input type="hidden" name="pdffile@fileSize" value="{pdffile@fileSize}" />

7〜9行目:アップロードしてあるファイルを削除する記述【任意】

<label for="input-checkbox-フィールド名@edit">
<input type="checkbox" name="フィールド名@edit" value="delete" id="input-checkbox-フィールド名@edit" /> 削除
</label>

10行目:アップロードしたファイルのアイコンとリンク表示【必須】

<a href="%{HTTP_ARCHIVES_DIR}{フィールド名@path}"><img src="アイコンファイルのパス" width="64" height="64" alt="代替テキスト" /></a>

11行目:ファイルを入力する記述【必須】

<input type="file" name="フィールド名" />

12行目:カスタムフィールドであることの記述【必須】

<input type="hidden" name="field[]" value="フィールド名" />

13行目:通常のフィールドではなく、拡張フィールドであることの記述【必須】

<input type="hidden" name="フィールド名:extension" value="file" />

14行目:アップロードするファイルの拡張子を指定【任意】

value属性に拡張子を記述します。ここで指定した種類のファイルのみアップロードできます。拡張子は1つのみ指定可能です。
指定していない場合はコンフィグの設定が適用されます。

<input type="hidden" name="フィールド名@extension" value="pdf" />
拡張子を複数指定したい

拡張子を複数指定してユーザーに入力のヒントを提示したい場合は、HTMLのaccept属性を使用することを推奨しています。

以下の例では、.pdf、.docx、.docの拡張子を許可しています。ユーザーは指定された拡張子のファイルのみ選択できるようになります。 <input type="file" name="フィールド名" accept=".pdf,.docx,.doc" />

15行目:アップロードする場所とファイル名を指定【任意】

カスタムフィールドからアップロードされたファイルは、/archives/bid/内に格納されます。(その他の場所にはアップロードできません。)※@filenameは@baseNameと違い、ファイル名を指定することができます。

<input type="hidden" name="フィールド名@filename" value="アップロードするファイルのパス" />

PDFファイルをアップロードしたカスタムフィールド

PDFファイルをアップロードしたカスタムフィールド


ファイル名をランダムにするには

valueの値を空欄にすることでランダムになります

<input type="hidden" name="pdffile@filename" value="" />
ファイル名をアップロードされたファイル名のままにするには

valueの値を"@rawfilename"にすることでそのままになります

<input type="hidden" name="pdffile@filename" value="@rawfilename" />

カスタムフィールドでアップロードしたファイルを表示

例)「pdffile」というフィールド名でPDFファイルをアップロードした場合

<!-- BEGIN pdffile:veil --><a href="%{HTTP_ARCHIVES_DIR}{pdffile@path}"><img src="アイコンファイルのパス" width="64" height="64" alt="代替テキスト" /></a><!-- END pdffile:veil -->

PDFファイルの表示

PDFファイルの表示

画像をアップロードする

画像をアップロードするカスタムフィールドついて詳しく説明します。
以下で説明しているファイルのカスタムフィールドは、ソースコードの生成はカスタムフィールドメーカーで簡単に作成できます。

画像をアップロードするカスタムフィールドの作成

例)PNGファイルをアップロードするカスタムフィールド(フィールド名:topVisual)

<!-- アップロード済みのファイルのプレビューエリア -->
<!-- BEGIN topVisual@path:veil -->
<img src="%{ARCHIVES_DIR}{topVisual@path}" width="{topVisual@x}" height="{topVisual@y}" alt="{topVisual@alt}" /><br />
<input type="hidden" name="topVisual@old" value="{topVisual@path}" />
<input type="hidden" name="topVisual@secret" value="{topVisual@secret}" />
<label for="input-checkbox-topVisual@edit">
<input type="checkbox" name="topVisual@edit" value="delete" id="input-checkbox-topVisual@edit" />
削除
</label><br /><!-- END topVisual@path:veil -->
<!-- イメージファイルをアップロードするフィールド -->
<input type="file" name="topVisual" size="20" />
<input type="hidden" name="field[]" value="topVisual" />
<input type="hidden" name="topVisual:extension" value="image" />
<input type="text" name="topVisual@alt" value="{topVisual@alt}" />
<input type="hidden" name="topVisual@extension" value="png" />
<input type="hidden" name="topVisual@filename" value="topVisual.png" />
<input type="hidden" name="topVisual@width" value="820" />

各記述の説明

3行目:アップロードした画像の表示【必須】

標準サイズ:normal / 画像(小):tiny / 画像(大):large 正方形サイズ(v.1.5.0より追加):square / 画像(正方形)

例)各画像サイズの記述例

<!-- BEGIN フィールド名@normal:veil --><img src="%{ARCHIVES_DIR}{フィールド名@path}" width="{フィールド名@x}" height="{フィールド名@y}" alt="{フィールド名@alt}" /><!-- END フィールド名@normal:veil --><br />
<!-- BEGIN フィールド名@tiny:veil --><img src="%{ARCHIVES_DIR}{フィールド名@tinyPath}" width="{フィールド名@tinyX}" height="{フィールド名@tinyY}" alt="{フィールド名@tinyAlt}" /><!-- END フィールド名@tiny:veil --><br />
<!-- BEGIN フィールド名@large:veil --><img src="%{ARCHIVES_DIR}{フィールド名@largePath}" width="{フィールド名@largeX}" height="{フィールド名@largeY}" alt="{フィールド名@largeAlt}" /><!-- END フィールド名@large:veil --><br />
<!-- BEGIN フィールド名@square:veil --><img src="%{ARCHIVES_DIR}{フィールド名@squarePath}" width="{フィールド名@squareX}" height="{フィールド名@squareY}" alt="{フィールド名@squareAlt}" /><!-- END フィールド名@square:veil --><br />

4行目:画像がアップロードされなかった場合に既存のアップロードされている画像の情報を送信する記述【必須】

<input type="hidden" name="フィールド名@old" value="{フィールド名@path}" />

6〜9行目:アップロードしてある画像を削除する記述【任意】

<label for="input-checkbox-フィールド名@edit">
<input type="checkbox" name="フィールド名@edit" value="delete" id="input-checkbox-フィールド名@edit" /> 削除
</label>

11行目:ファイルを入力する記述【必須】

<input type="file" name="フィールド名" />

12行目:画像のカスタムフィールドであることの記述【必須】

<input type="hidden" name="field[]" value="フィールド名" />

13行目:通常のフィールドではなく、拡張フィールドであることの記述【必須】

<input type="hidden" name="フィールド名:extension" value="image" />

14行目:altの指定【任意】

<input type="text" name="フィールド名@alt" value="{フィールド名@alt}" />

15行目:アップロードする画像の拡張子を指定【任意】

拡張子を指定し、画像の形式も自働的に変換されます。

<input type="hidden" name="フィールド名@extension" value="拡張子" />

16行目:アップロードする場所とファイル名を指定【任意】

カスタムフィールドからアップロードされた画像は、/archives/bid/内に格納されます。(その他の場所にはアップロードできません。)

<input type="hidden" name="フィールド名@filename" value="アップロードする画像のパス" />

17行目:アップロードする画像の大きさを指定【任意】

幅(width)と高さ(height)を指定します。幅と高さどちらかを指定すると指定した大きさを元に縦横比に合わせて画像がリサイズされます。「size」は画像の長辺を指定します。

<input type="hidden" name="フィールド名@width" value="画像の幅の数値" />
<input type="hidden" name="フィールド名@height" value="画像の高さの数値" />
<input type="hidden" name="フィールド名@size" value="画像の長辺の数値" />

画像(小)と(大)と(正方形)の大きさを指定することもできます。指定した場合にのみ、画像(小)と(大)と(正方形)の画像が作成されます。 ※正方形画像はv.1.5.0から使用できる機能です。

画像(小)の場合
tinyWidth, tinyHeight, tinySize
画像(大)の場合
largeWidth, largeHeight, largeSize
画像(正方形)の場合
squareWidth, squareHeight, squareSize

例)各画像サイズの記述例

<input type="hidden" name="フィールド名@width" value="画像の幅の数値" />
<input type="hidden" name="フィールド名@height" value="画像の高さの数値" />
<input type="hidden" name="フィールド名@size" value="画像の長辺の数値" />
<input type="hidden" name="フィールド名@tinyWidth" value="画像(小)の幅の数値" />
<input type="hidden" name="フィールド名@tinyHeight" value="画像(小)の高さの数値" />
<input type="hidden" name="フィールド名@tinySize" value="画像(小)の長辺の数値" />
<input type="hidden" name="フィールド名@largeWidth" value="画像(大)の幅の数値" />
<input type="hidden" name="フィールド名@largeHeight" value="画像(大)の高さの数値" />
<input type="hidden" name="フィールド名@largeSize" value="画像(大)の長辺の数値" />
<input type="hidden" name="フィールド名@squareWidth" value="画像(正方形)の幅の数値" />
<input type="hidden" name="フィールド名@squareHeight" value="画像(正方形)の高さの数値" />
<input type="hidden" name="フィールド名@squareSize" value="画像(正方形)の長辺の数値" />

※Widthでは横の長さを、Heightでは縦の長さを、Sizeでは長辺を基準にして指定することができます。

OpenStreetMapのカスタムフィールドの作成

a-blog cmsの組み込みJSを使えば、下の図のようなOpenStreetMapのインターフェースを使って、緯度・経度・ズームの値をカスタムフィールドとして登録することができます。ここではその方法について、登録側(管理画面)と表示側に分けてご紹介します。



登録側(管理画面)の記述

OpenStreetMapのインターフェースのカスタムフィールドのサンプルHTMLになります。

<table class="entryFormTable acms-table-entry">
  <tr class="js-open-street-map-editable">
    <th>地図</th>
    <td>
	<div class="acms-form-group">
	  <input type="text" name="" value="" class="js-osm-search" size="40" />
	  <button type="button" class="js-osm-search-btn acms-admin-btn-admin">検索</button>
	</div>
	<div class="acms-form-group">
	  <div class="acms-admin-gmap-container js-open-street-map-picker" style="position:relative; overflow: hidden; width: 100%; height: 300px;"></div>
	</div>
	<div class="acms-form-group">
	  緯度 <input type="text" name="mapLat" value="{mapLat}" size="9" class="js-osm-lat" />
	  経度 <input type="text" name="mapLng" value="{mapLng}" size="10" class="js-osm-lng" />
	  ズーム <input type="text" name="mapZoom" value="{mapZoom}" size="10" class="js-osm-zoom" />
	</div>
	<input type="hidden" name="field[]" value="mapLat" />
	<input type="hidden" name="field[]" value="mapLng" />
	<input type="hidden" name="field[]" value="mapZoom" />
    </td>
  </tr>
</table>

記述の説明

まず、js-open-street-map-editableというクラスでOpenStreetMapのインターフェースを適応したいエリア全体に記述してください。

<tr class="js-open-street-map-editable">

次に以下のようにjs-open-street-map-pickerというクラスをdivなどの要素に記述することによってピン付きのマップを表示することができます。

<div class="acms-admin-gmap-container js-open-street-map-picker" style="position:relative; overflow: hidden; width: 100%; height: 300px;"></div>

緯度・経度・ズームの値を入力箇所は以下のように記述します。緯度のフィールドにはjs-osm-latを、経度の情報にはjs-osm-lng、ズーム値のフィールドにはjs-osm-zoomを記述してください。そうすることで、OpenStreetMapのピンの位置とフィールドの値を紐づけることができます。

緯度 <input type="text" name="mapLat" value="{mapLat}" size="9" class="js-osm-lat" />
経度 <input type="text" name="mapLng" value="{mapLng}" size="10" class="js-osm-lng" />
ズーム <input type="text" name="mapZoom" value="{mapZoom}" size="10" class="js-osm-zoom" />
<input type="hidden" name="field[]" value="mapLat" />
<input type="hidden" name="field[]" value="mapLng" />
<input type="hidden" name="field[]" value="mapZoom" />

また、下のようなHTMLを記述すれば、スポットの位置を住所やスポット名で検索するための入力エリアを作ることもできますが、検索の精度はそれほどよくないので、検索結果の緯度経度が実際のものとずれている場合もあります。その場合は手動でピンを動かして緯度経度を設定してください。

<input type="text" name="" value="" class="js-osm-search" />
<button type="button" class="js-osm-search-btn acms-admin-btn-admin">検索</button>

表側の記述

緯度 {mapLat}、経度 {mapLng}、ズーム {mapZoom} という変数の場合は以下のように記述します。エントリーのカスタムフィールドで作成した場合はEntry系モジュールのentry:loop内に記述してください。

<div class="js-open-street-map" data-lat="{mapLat}" data-lng="{mapLng}" data-zoom="{mapZoom}" style="width: 100%; height: 300px;"></div>

Google Mapsのカスタムフィールドの作成

Google Mapsのインターフェースのカスタムフィールドを使って、緯度・経度・ズームの値を入力することができます。



Google MapsのインターフェースのカスタムフィールドのサンプルHTMLになります。

<table class="entryFormTable acms-table-entry">
  <tr class="js-map-editable">
    <th>地図</th>
    <td>
      <div class="acms-form-group">
        <input type="text" name="" value="" class="js-editable_map-search_text" disabled="disabled" size="40" />
        <button type="button" class="js-editable_map-search_button acms-admin-btn-admin" disabled="disabled">検索</button>
      </div>
      <div class="acms-form-group">
        <img class="js-map_editable-container" src="http://maps.google.com/maps/api/staticmap?center=35.185574,136.899066&zoom=10&size=400x300&maptype=roadmap&markers=35.185574,136.899066&sensor=false" width="400" height="300" style="display:block;" />
      </div>
      <div class="acms-form-group">
        <!-- BEGIN_IF [{mapLat}/em] -->
        緯度 <input type="text" name="mapLat" value="35.185574" size="9" class="js-map_editable-lat" />
        経度 <input type="text" name="mapLng" value="136.899066" size="10" class="js-map_editable-lng" />
        ズーム <input type="text" name="mapZoom" value="10" size="10" class="js-map_editable-zoom" />
        <!-- ELSE -->
        緯度 <input type="text" name="mapLat" value="{mapLat}" size="9" class="js-map_editable-lat" />
        経度 <input type="text" name="mapLng" value="{mapLng}" size="10" class="js-map_editable-lng" />
        ズーム <input type="text" name="mapZoom" value="{mapZoom}" size="10" class="js-map_editable-zoom" />
        <!-- END_IF -->
      </div>
      <input type="hidden" name="field[]" value="mapLat" />
      <input type="hidden" name="field[]" value="mapLng" />
      <input type="hidden" name="field[]" value="mapZoom" />
    </td>
  </tr>
</table>

記述の説明

Google Mapsをカスタムフィールドで利用するための記述。各記述全体を囲む要素に記述してください。

<tr class="js-map-editable">

住所やスポット名で検索するための入力エリア

<input type="text" name="" value="" class="js-editable_map-search_text" disabled="disabled" size="40" />
<button type="button" class="js-editable_map-search_button acms-admin-btn-admin" disabled="disabled">検索</button>

マップのプレビュー

<img class="js-map_editable-container" src="https://maps.googleapis.com/maps/api/staticmap?center=35.185574,136.899066&zoom=10&size=400x300&maptype=roadmap&markers=35.185574,136.899066&sensor=false&key=%{GOOGLE_API_KEY}" width="400" height="300" style="display:block;" />

緯度・経度・ズームの値を入力箇所

<!-- BEGIN_IF [{mapLat}/em] -->
緯度 <input type="text" name="mapLat" value="35.185574" size="9" class="js-map_editable-lat" />
経度 <input type="text" name="mapLng" value="136.899066" size="10" class="js-map_editable-lng" />
ズーム <input type="text" name="mapZoom" value="10" size="10" class="js-map_editable-zoom" />
<!-- ELSE -->
緯度 <input type="text" name="mapLat" value="{mapLat}" size="9" class="js-map_editable-lat" />
経度 <input type="text" name="mapLng" value="{mapLng}" size="10" class="js-map_editable-lng" />
ズーム <input type="text" name="mapZoom" value="{mapZoom}" size="10" class="js-map_editable-zoom" />
<!-- END_IF -->

テンプレートに表示する

単一で表示する

緯度が {mapLat}、経度が {mapLng}、ズームが {mapZoom} という変数の場合は以下のように記述します(ここでは説明しやすいように具体的な変数名を使用しますが、実際の変数名は任意です)。エントリーのカスタムフィールドで作成した場合はEntry系モジュールのentry:loop内に記述してください。

<img class="js-s2d-ready" src="https://maps.googleapis.com/maps/api/staticmap?center={mapLat},{mapLng}&zoom={mapZoom}&size=400x300&maptype=roadmap&markers={mapLat},{mapLng}&sensor=false" width="400" height="300" style="display:block;" />

一覧ページで複数のピンを表示する

エントリーのカスタムフィールドで緯度を{map_lat}、経度が{map_lng}、カテゴリーのカスタムフィールドで緯度を{index_map_lat}、経度を{index_map_lng}、ズームを{index_map_zoom}を指定している例です。

下記の例では、それぞれmarkersとalt属性にEntry_Summaryを使うことで複数ピンの表示と、ピンをクリックした後の吹き出しを表示しています。

<!-- BEGIN_MODULE Category_Field -->
<div>
<!-- BEGIN_MODULE Entry_Summary id="summary_map" -->
  <!-- BEGIN_SetRendered id="map-markers" -->
  <!-- BEGIN unit:loop --><!-- BEGIN entry:loop -->{map_lat},{map_lng}<!-- BEGIN glue -->|<!-- END glue --><!-- END entry:loop --><!-- END unit:loop -->
  <!-- END_SetRendered -->

  <!-- BEGIN_SetRendered id="map-messages" -->
  <!-- BEGIN unit:loop --><!-- BEGIN entry:loop -->&lt;table&gt;&lt;tr&gt;&lt;td&gt;&lt;a href=&quot;{url}&quot;&gt;&lt;!-- BEGIN image:veil --&gt;&lt;img src=&quot;%{MEDIA_ARCHIVES_DIR}{main_photo@path}&quot; width=&quot;200&quot; alt=&quot;&quot; /&gt;&lt;br/&gt;&lt;!-- END image:veil --&gt;{title}&lt;/a&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;<!-- BEGIN glue -->[[:split:]]<!-- END glue --><!-- END entry:loop --><!-- END unit:loop -->
  <!-- END_SetRendered -->
<!-- END_MODULE Entry_Summary -->

<img class="js-s2d-ready" src="http://maps.google.com/maps/api/staticmap?center={index_map_lat},{index_map_lng}&zoom={index_map_zoom}&size=820x400&maptype=roadmap&markers=<!-- GET_Rendered id="map-markers" trim="1" -->&sensor=false" alt="<!-- GET_Rendered id="map-messages" trim="1" -->" width="820" height="400" style="display:block;" />
</div>
<!-- BEGIN_MODULE Touch_SessionWithCompilation --> <p class="edit-link">[<a href="%{BLOG_URL}bid/%{BID}/cid/%{CID}/admin/category_edit/">編集</a>]</p><!-- END_MODULE Touch_SessionWithCompilation -->
<!-- END_MODULE Category_Field -->

ストリートビューを利用する

a-blog cms Ver.2.11よりGoogle Mapユニットでストリートビューが利用できるようになりました。それに伴いカスタムフィールドでもストリートビューの表示位置を調整して表示することができるようになりました。 以下はストリートビューを使ったカスタムフィールドのイメージです。


以下はストリートビュー対応したGoogle MapsのカスタムフィールドのサンプルHTMLになります。

<table class="entryFormTable acms-table-entry">
  <tr class="js-map-editable">
    <th>地図</th>
    <td>
      <div class="acms-form-group">
        <input type="text" name="" value="" class="js-editable_map-search_text" disabled="disabled" size="40" />
        <button type="button" class="js-editable_map-search_button acms-admin-btn-admin"
          disabled="disabled">検索</button>
      </div>
      <div class="acms-form-group">
        <!-- BEGIN_IF [{mapLat}/em]-->
        <img class="js-map_editable-container"
          src="//maps.google.com/maps/api/staticmap?center=35.185574,136.899066&zoom=10&size=400x400&maptype=roadmap&markers=35.185574,136.899066&key=%{GOOGLE_API_KEY}"
          width="400" height="300" style="display:block;" />
        <!-- ELSE -->
        <img class="js-map_editable-container"
          src="//maps.google.com/maps/api/staticmap?center={mapLat},{mapLng}&zoom={zoom}&size=400x400&maptype=roadmap&markers={mapLat},{mapLng}&key=%{GOOGLE_API_KEY}"
          width="400" height="300" style="display:block;" />
        <!-- END_IF -->
        <div class="js-map_editable-panorama" style="width: 100%; height: 600px; display: none;"></div>
      </div>
      <div class="acms-form-group" style="margin-bottom: 10px; margin-top: 10px;">
        <!-- BEGIN_IF [{mapLat}/em] -->
        緯度 <input type="text" name="mapLat" value="35.185574" size="9" class="js-map_editable-lat" />
        経度 <input type="text" name="mapLng" value="136.899066" size="10" class="js-map_editable-lng" />
        ズーム <input type="text" name="mapZoom" value="10" size="10" class="js-map_editable-zoom" />
        <!-- ELSE -->
        緯度 <input type="text" name="mapLat" value="{mapLat}" size="9" class="js-map_editable-lat" />
        経度 <input type="text" name="mapLng" value="{mapLng}" size="10" class="js-map_editable-lng" />
        <!-- ズーム <input type="text" name="mapZoom" value="{mapZoom}" size="10" class="js-map_editable-zoom" /> -->
        <!-- END_IF -->

      </div>
      <input type="hidden" name="field[]" value="mapLat" />
      <input type="hidden" name="field[]" value="mapLng" />
      <input type="hidden" name="field[]" value="mapZoom" />
      <input type="hidden" name="field[]" value="viewZoom" />
      <input type="hidden" name="field[]" value="viewHeading" />
      <input type="hidden" name="field[]" value="viewPitch" />
      <div class="acms-admin-form-checkbox">
        <input type="checkbox" id="viewActivate" name="viewActivate" value="true" class='js-map_editable-activate' />
        <label for="viewActivate">
          <i class="acms-admin-ico-checkbox"></i>ストリートビューを利用する
        </label>
      </div>
      <div>
        ズーム <input type="text" name="viewZoom" value="{viewZoom}" size="9" class="js-map_editable-zoom-view" />
        方向 <input type="text" name="viewHeading" value="{viewHeading}" size="10" class="js-map_editable-heading" />
        ピッチ <input type="text" name="viewPitch" value="{viewPitch}" size="10" class="js-map_editable-pitch" />
      </div>
    </td>
  </tr>
</table>

ストリートビューの表示

また登録したストリートビューは以下のように表示できます。

<div class="js-street-view column-street-view-inner" data-lazy="true" data-lat="{mapLat}" data-lng="{mapLng}" data-pitch="{viewPitch}" data-zoom="{viewZoom}" data-heading="{viewHeading}"></div>

カスタムフィールドの検索

検索とURLコンテキスト

a-blog cmsでは、いま表示しているページがWebサイトのどこにいるか、どのような状態であるかをURL上のパスとして表現しています。(これを「URLコンテキスト」といいます。)
例えば以下のURLは、

http://example.com/search/field/price/100/300/

「searchカテゴリーの、priceというフィールドの値が100または300」の情報を表示します。

この検索機能によりサイトの利用者にとっての検索性を高めることが可能になります。

Field_Searchモジュール

Field_Searchモジュールを使えば、サイトの利用者はより簡単にサイトの情報を検索することができます。というのも「URLコンテキスト」を利用するための検索フォームを提供できるからです。

例えば下の図の検索フォームですと、URLコンテキストはフォームのカスタマイズにより、以下のURLのようになります。

http://example.com/realestate/field/price/gte/30000/lte/50000/_and_/station/JR名古屋駅/


URLコンテキストを利用した検索方法

URLコンテキストを利用した検索方法は以下のような方法があります。

  1. 簡単な検索
  2. 簡単な検索 [複数条件・or検索]
  3. 演算子検索
  4. 演算子検索 [複数条件・and検索]
  5. 演算子選択単数
  6. 演算子、結合子選択 [複数条件]
  7. チェックボックスを使用した複数条件指定
  8. 違うフィールドの複合検索 [複数条件]

1.簡単な検索

合致する条件を一つ指定する検索です。指定した条件に合致するエントリーが表示されます。

URLコンテキストの例

http://example.com/field/price/100

検索フォームの例


Field_Searchモジュールの例

<!-- BEGIN_MODULE Field_Search -->
<form action="" method="post" class="acms-form">
  <table>
    <tr>
      <th>価格</th>
      <th>検索</th>
    </tr>
    <tr>
      <td>
        <label class="acms-form-radio">
        <input type="radio" name="price" value="100"{price:checked#100} /><i class="acms-ico-radio"></i>100</label>
        <label class="acms-form-radio">
        <input type="radio" name="price" value="200"{price:checked#200} /><i class="acms-ico-radio"></i>200</label>
        <label class="acms-form-radio">
        <input type="radio" name="price" value="300"{price:checked#300} /><i class="acms-ico-radio"></i>300</label>
        <input type="hidden" name="field[]" value="price" />
      </td>
      <td>
        <input type="hidden" name="cid" value="%{CID}" />
        <input type="hidden" name="bid" value="%{BID}" />
        <input type="submit" name="ACMS_POST_2GET" value="検索" class="acms-btn-admin" />
      </td>
    </tr>
  </table>
</form>
<!-- END_MODULE Field_Search -->

2.簡単な検索 [複数条件・or検索]

合致する条件を複数指定する検索です。指定した条件のいずれかに合致する(=OR検索)エントリーが表示されます。

※注意:同じフィールドの値でAND検索は利用できません。

URLコンテキストの例

http://example.com/field/price/200/300/

検索フォームの例


Field_Searchモジュールの例

<!-- BEGIN_MODULE Field_Search -->
<form action="" method="post" class="acms-form">
  <table>
      <tr>
        <th>価格</th>
        <th>検索</th>
      </tr>
      <tr>
        <td>
          <label class="acms-form-checkbox" for="input-price-100">
            <input type="checkbox" name="price[]" value="100" id="input-price-100"{price:checked#100} />
            <i class="acms-ico-checkbox"></i>100
          </label>
          <label class="acms-form-checkbox" for="input-price-200">
            <input type="checkbox" name="price[]" value="200" id="input-price-200"{price:checked#200} />
            <i class="acms-ico-checkbox"></i>200
          </label>
          <label class="acms-form-checkbox" for="input-price-300">
            <input type="checkbox" name="price[]" value="300" id="input-price-300"{price:checked#300} />
            <i class="acms-ico-checkbox"></i>300
          </label>
          <input type="hidden" name="field[]" value="price" />
        </td>
        <td>
          <input type="hidden" name="cid" value="%{CID}" />
          <input type="hidden" name="bid" value="%{BID}" />
          <input type="submit" name="ACMS_POST_2GET" value="検索" class="acms-btn-admin" />
        </td>
      </tr>
  </table>
</form>
<!-- END_MODULE Field_Search -->

3.演算子検索

演算子で条件を指定する検索です。条件に合致するエントリーが表示されます。

URLコンテキストの例

http://example.com/field/price/lte/300/

検索フォームの例


Field_Searchモジュールの例

<!-- BEGIN_MODULE Field_Search -->
<form action="" method="post" class="acms-form">
  <!-- 宣言 -->
  <input type="hidden" name="field[]" value="price" />
  <!-- 演算子 -->
  <input type="hidden" name="price@operator" value="lte" />
  <table>
    <tr>
      <th>価格</th>
      <th>検索</th>
    </tr>
    <tr>
      <td>
        <select name="price">
          <option value="">上限なし</option>
          <option value="300"{price:selected#300}>300円以下</option>
          <option value="200"{price:selected#200}>200円以下</option>
          <option value="100"{price:selected#100}>100円以下</option>
        </select>
      </td>
      <td>
        <input type="hidden" name="cid" value="%{CID}" />
        <input type="hidden" name="bid" value="%{BID}" />
        <input type="submit" name="ACMS_POST_2GET" value="検索" class="acms-btn-admin" />
      </td>
    </tr>
  </table>
</form>
<!-- END_MODULE Field_Search -->

演算子部分の記述

<input type="hidden" name="カスタムフィールド名@operator" value="演算子" />
name属性

カスタムフィールド名の後ろに「@operator」を記述します。

Value属性

演算子を記述します。

演算子条件意味
eq=等しい
neq!=等しくない
gt>より大きい
gte>=以上
lt<より小さい
lte<=以下
lkLIKE含まれる
nlkNOT LIKE含まれない
reREGEXXP指定した表記表現に合致する
nreNOT REGEXP指定した正規表現に合致しない
emEMPTY値が空(何も入ってこない)
nemNOT EMPTY値が空(何も入ってこない)ではない

4. 演算子検索 [複数条件・and検索]

複数の演算子で条件を指定する検索です。すべての条件に合致する(=and検索)エントリーが表示されます。

URLコンテキストの例

http://example.com/field/price/gte/300/lte/100/

検索フォームの例


Field_Searchモジュールの例

<!-- BEGIN_MODULE Field_Search -->
<form action="" method="post" class="acms-form">
  <!-- 宣言 -->
  <input type="hidden" name="field[]" value="price" />
  <!-- 演算子 -->
  <input type="hidden" name="price@operator[0]" value="gte" />
  <input type="hidden" name="price@operator[1]" value="lte" />
  <table>
    <tr>
      <th>価格(下限)</th>
      <th>価格(上限)</th>
      <th>検索</th>
    </tr>
    <tr>
      <td>
        <select name="price[]">
          <option value="">下限なし</option>
          <option value="300"{price[0]:selected#300}>300円以上</option>
          <option value="200"{price[0]:selected#200}>200円以上</option>
          <option value="100"{price[0]:selected#100}>100円以上</option>
        </select>
      </td>
      <td>
        <select name="price[]">
          <option value="">上限なし</option>
          <option value="300"{price[1]:selected#300}>300円以下</option>
          <option value="200"{price[1]:selected#200}>200円以下</option>
          <option value="100"{price[1]:selected#100}>100円以下</option>
        </select>
      </td>
      <td>
        <input type="hidden" name="cid" value="%{CID}" />
        <input type="hidden" name="bid" value="%{BID}" />
        <input type="submit" name="ACMS_POST_2GET" value="検索" class="acms-btn-admin" />
      </td>
    </tr>
  </table>
</form>
<!-- END_MODULE Field_Search -->

5.演算子選択単数

条件の値を入力し、かつ演算子を指定する検索です。条件に合致するエントリーが表示されます。

URLコンテキストの例

http://example.com/field/price/neq/200/

検索フォームの例


Field_Searchモジュールの例

<!-- BEGIN_MODULE Field_Search -->
<form action="" method="post" class="acms-form">
  <!-- 宣言 -->
  <input type="hidden" name="field[]" value="price" />
  <table>
    <tr>
      <th>オペレータ</th>
      <th>価格</th>
      <th>検索</th>
    </tr>
    <tr>
      <td>
        <select name="price@operator">
          <option value="eq"{price@operator:selected#eq}>=</option>
          <option value="neq"{price@operator:selected#neq}>!=</option>
          <option value="lt"{price@operator:selected#lt}>&lt;</option>
          <option value="lte"{price@operator:selected#lte}>&lt;=</option>
          <option value="gt"{price@operator:selected#gt}>&gt;</option>
          <option value="gte"{price@operator:selected#gte}>&gt;=</option>
          <option value="lk"{price@operator:selected#lk}>LIKE</option>
          <option value="nlk"{price@operator:selected#nlk}>NOT LIKE</option>
          <option value="re"{price@operator:selected#re}>REGEXP</option>
          <option value="nre"{price@operator:selected#nre}>NOT REGEXP</option>
          <option value="em"{price@operator:selected#em}>EMPTY</option>
          <option value="nem"{price@operator:selected#nem}>NOT EMPTY</option>
        </select>
      </td>
      <td>
        <input type="text" name="price" value="{price}" size="10" />
      </td>
      <td>
        <input type="hidden" name="cid" value="%{CID}" />
        <input type="hidden" name="bid" value="%{BID}" />
        <input type="submit" name="ACMS_POST_2GET" value="検索" class="acms-btn-admin" />
      </td>
    </tr>
  </table>
</form>
<!-- END_MODULE Field_Search -->

6.演算子、結合子選択[複数条件]

条件の値を入力し、かつ演算子を指定する検索です。複数の条件をand検索かor検索で条件に合致するエントリーが表示されます。

URLコンテキストの例

http://example.com/field/price/gte/300/or/lte/150/

検索フォームの例


Field_Searchモジュールの例

<!-- BEGIN_MODULE Field_Search -->
<form action="" method="post" class="acms-form">
  <!-- 宣言 -->
  <input type="hidden" name="field[]" value="price" />
  <input type="hidden" name="price[0]" />
  <input type="hidden" name="price[1]" />
  <input type="hidden" name="price@connector[0]" />
  <input type="hidden" name="price@connector[1]" />
  <input type="hidden" name="price@operator[0]" />
  <input type="hidden" name="price@operator[1]" />

  <table>
    <tr>
      <th>価格</th>
      <th>AND OR</th>
      <th>価格</th>
      <th>検索</th>
    </tr>
    <tr>
      <td>
        <select name="price@operator[0]">
          <option value="">選択しない</option>
          <option value="eq"{price@operator[0]:selected#eq}>=</option>
          <option value="neq"{price@operator[0]:selected#neq}>!=</option>
          <option value="lt"{price@operator[0]:selected#lt}>&lt;</option>
          <option value="lte"{price@operator[0]:selected#lte}>&lt;=</option>
          <option value="gt"{price@operator[0]:selected#gt}>&gt;</option>
          <option value="gte"{price@operator[0]:selected#gte}>&gt;=</option>
          <option value="lk"{price@operator[0]:selected#lk}>LIKE</option>
          <option value="nlk"{price@operator[0]:selected#nlk}>NOT LIKE</option>
          <option value="re"{price@operator[0]:selected#re}>REGEXP</option>
          <option value="nre"{price@operator[0]:selected#nre}>NOT REGEXP</option>
          <option value="em"{price@operator[0]:selected#em}>EMPTY</option>
          <option value="nem"{price@operator[0]:selected#nem}>NOT EMPTY</option>
        </select><br/>
        <input type="text" name="price[0]" value="{price[0]}" size="10" />
        円
      </td>
      <td>
        <label class="acms-form-radio">
        <input type="radio" name="price@connector[1]" value="and"{price@connector[1]:checked#and} /><i class="acms-ico-radio"></i>and</label>
        <label class="acms-form-radio">
        <input type="radio" name="price@connector[1]" value="or"{price@connector[1]:checked#or} /><i class="acms-ico-radio"></i>or</label>
        <input type="hidden" name="field[]" value="price@connector[1]" />
      </td>
      <td>
        <select name="price@operator[1]">
          <option value="">選択しない</option>
          <option value="eq"{price@operator[1]:selected#eq}>=</option>
          <option value="neq"{price@operator[1]:selected#neq}>!=</option>
          <option value="lt"{price@operator[1]:selected#lt}>&lt;</option>
          <option value="lte"{price@operator[1]:selected#lte}>&lt;=</option>
          <option value="gt"{price@operator[1]:selected#gt}>&gt;</option>
          <option value="gte"{price@operator[1]:selected#gte}>&gt;=</option>
          <option value="lk"{price@operator[1]:selected#lk}>LIKE</option>
          <option value="nlk"{price@operator[1]:selected#nlk}>NOT LIKE</option>
          <option value="re"{price@operator[1]:selected#re}>REGEXP</option>
          <option value="nre"{price@operator[1]:selected#nre}>NOT REGEXP</option>
          <option value="em"{price@operator[1]:selected#em}>EMPTY</option>
          <option value="nem"{price@operator[1]:selected#nem}>NOT EMPTY</option>
        </select><br/>
        <input type="text" name="price[1]" value="{price[1]}" size="10" />
        円
      </td>
      <td>
        <input type="hidden" name="cid" value="%{CID}" />
        <input type="hidden" name="bid" value="%{BID}" />
        <input type="submit" name="ACMS_POST_2GET" value="検索" class="acms-btn-admin" />
      </td>
    </tr>
  </table>
</form>
<!-- END_MODULE Field_Search -->

チェックボックスを使用した複数条件指定

チェックボックスで複数の条件指定する検索です。複数の条件をand検索かor検索で条件に合致するエントリーが表示されます。

URLコンテキストの例

http://example.com/field/price/or/lt/100/100/or/nem//or/gt/300/

検索フォームの例


Field_Searchモジュールの例

<!-- BEGIN_MODULE Field_Search -->
<form action="" method="post" class="acms-form">
  <!-- 宣言 -->
  <input type="hidden" name="field[]" value="price" />

  <input type="hidden" name="price[0]" />
  <input type="hidden" name="price[1]" />
  <input type="hidden" name="price[2]" />
  <input type="hidden" name="price[3]" />
  <input type="hidden" name="price[4]" />

  <input type="hidden" name="price@operator[0]" />
  <input type="hidden" name="price@operator[1]" />
  <input type="hidden" name="price@operator[2]" />
  <input type="hidden" name="price@operator[3]" />
  <input type="hidden" name="price@operator[4]" />

  <input type="hidden" name="price@connector[0]" />
  <input type="hidden" name="price@connector[1]" />
  <input type="hidden" name="price@connector[2]" />
  <input type="hidden" name="price@connector[3]" />
  <input type="hidden" name="price@connector[4]" />

  <!-- 演算子 -->
  <input type="hidden" name="price@operator[0]" value="lt" />
  <input type="hidden" name="price@operator[1]" value="eq" />
  <input type="hidden" name="price@operator[3]" value="eq" />
  <input type="hidden" name="price@operator[4]" value="gt" />

  <!-- 結合子 -->
  <input type="hidden" name="price@connector" value="and" />

  <table>
    <tr>
      <th>AND OR</th>
      <th>価格</th>
      <th>検索</th>
    </tr>
    <tr>
      <td>
        <label for="input-radio-price-connector-and" class="acms-form-radio">
          <input type="radio" name="price@connector" value="and"{price@connector:checked#and} id="input-radio-price-connector-and" />
          <i class="acms-ico-radio"></i>
          and
        </label>
        <label for="input-radio-price-connector-or" class="acms-form-radio">
          <input type="radio" name="price@connector" value="or"{price@connector:checked#or} id="input-radio-price-connector-or" />
          <i class="acms-ico-radio"></i>
          or
        </label>
      </td>
      <td>
        <label for="input-checkbox-price-0" class="acms-form-checkbox">
          <input type="checkbox" name="price[0]" value="100"{price[0]:checked#100} id="input-checkbox-price-0" />
          <i class="acms-ico-checkbox"></i>
          100未満
        </label>
        <label for="input-checkbox-price-1" class="acms-form-checkbox">
          <input type="checkbox" name="price[1]" value="100"{price[1]:checked#100} id="input-checkbox-price-1" />
          <i class="acms-ico-checkbox"></i>
          100
        </label>
        <label for="input-checkbox-price-2" class="acms-form-checkbox">
          <input type="checkbox" name="price@operator[2]" value="nem" id="input-checkbox-price-2"{price@operator[2]:checked#nem} />
          <i class="acms-ico-checkbox"></i>
          空ではない
        </label>
        <label for="input-checkbox-price-3" class="acms-form-checkbox">
          <input type="checkbox" name="price[3]" value="300"{price[3]:checked#300} id="input-checkbox-price-3" />
          <i class="acms-ico-checkbox"></i>
          300
        </label>
        <label for="input-checkbox-price-4" class="acms-form-checkbox">
          <input type="checkbox" name="price[4]" value="300"{price[4]:checked#300} id="input-checkbox-price-4" />
          <i class="acms-ico-checkbox"></i>
          300超
        </label>
      </td>
      <td>
        <input type="hidden" name="cid" value="%{CID}" />
        <input type="hidden" name="bid" value="%{BID}" />
        <input type="submit" name="ACMS_POST_2GET" value="検索" class="acms-btn-admin" />
      </td>
    </tr>
  </table>
</form>
<!-- END_MODULE Field_Search -->

8.違うフィールドの複合検索 [複数条件]

Ver. 2.1.1以前は、違うカスタムフィールドの複合検索はAND検索のみしかできませんでしたが、Ver2.1.1からOR検索にも対応しました。

AND検索とOR検索ですが、混ぜて使うことは出来ません。ただし AND -> OR の順番なら可能です。

AND検索のURL

http://example.com/field/price/gte/1000/and/color/red <!-- 以前からのURL -->
<!-- または -->
http://examplecom/field/price/gte/1000/_and_/color/red/

「and」または「_and_」で繋げる事により、違うフィールドのAND検索を行えるようになります。 この場合、priceが1000以上かつcolorがredなものを検索します。

OR検索のURL

http://example.com/field/price/gte/1000/_or_/color/red

「_or_」で繋げる事により、違うフィールドのOR検索を行えるようになります。 この場合、priceが1000以上、またはcolorがredなものを検索します。

※注意 : em(空の時)はOR検索で利用できません。

Field_Searchモジュールの例

<!-- BEGIN_MODULE Field_Search -->
<form action="" method="post" class="acms-form">
  <table class="realestateSearch">
    <tr class="acms-hide-sp">
      <th>最寄り駅</th>
      <th>家賃</th>
      <th>検索</th>
    </tr>
    <tr>
      <td>
      <span class="acms-hide-md acms-hide-pc">最寄り駅</span>
      <select name="station">
        <option value="">未設定</option>
        <option value="あの駅"{station:selected#あの駅}>あの駅</option>
        <option value="この駅"{station:selected#この駅}>この駅</option>
        <option value="その駅"{station:selected#その駅}>その駅</option>
      </select>
      <input type="hidden" name="field[]" value="station" />
      </td>
      <td class="tableNowrap">
        <span class="acms-hide-md acms-hide-pc acms-show-sp">家賃</span>
        <select name="price[]">
          <option value="">下限なし</option>
          <option value="30000"{price[0]:selected#30000}>30,000円以上</option>
          <option value="50000"{price[0]:selected#50000}>50,000円以上</option>
          <option value="80000"{price[0]:selected#80000}>80,000円以上</option>
        </select>
       - 
        <select name="price[]">
          <option value="">上限なし</option>
          <option value="80000"{price[1]:selected#80000}>80,000円以下</option>
          <option value="50000"{price[1]:selected#50000}>50,000円以下</option>
          <option value="30000"{price[1]:selected#30000}>30,000円以下</option>
        </select>
        
        <input type="hidden" name="field[]" value="price" />
        <input type="hidden" name="price@operator[0]" value="gte" />
        <input type="hidden" name="price@operator[1]" value="lte" />
      </td>

      <td>
        <input type="hidden" name="cid" value="%{CID}" />
        <input type="hidden" name="bid" value="%{BID}" />
        <input type="hidden" name="price@separator" value="or" />
        <input type="submit" name="ACMS_POST_2GET" value="検索" class="btn btnSearchBlock" />
      </td>
    </tr>
  </table>
</form>
<!-- END_MODULE Field_Search -->

フィールド名@separator に and または or を設定する事により、設定できるようになります。

カスタムフィールドのデータを検索の対象外にする

キーワード検索( /keyword/検索ワード/ や ?keyword=検索ワード )で、カスタムフィールドの値が検索に引っかからないように設定することができます。例えば、商品の値段をカスタムフィールドで登録しており、一般ユーザには商品の値段を表示したくないケース等に使うことができます。

例えば、カスタムフィールドがpriceの場合、name属性にprice:searchと設定し、value="0"とします。

<input type="text" name="price" value="{price}" />
<input type="hidden" name="field[]" value="price" />
<!-- 下を追加 -->
<input type="hidden" name="price:search" value="0">

フィールド検索にも適用する(Ver. 3.2.36 以降)

:search に 0 を指定したフィールドは、標準ではキーワード検索の対象から外れるだけで、フィールド検索(/field/price/1000/ や field[]= による絞り込み、Field_ValueList など)では引き続き値で検索できます。値そのものを推測されたくない場合(上の例の「商品の値段」など)は、フィールド検索にもこの設定を適用してください。

private/config.system.yaml に次を書くと、:search が 0 のフィールドはフィールド検索からも「値が無い」ものとして扱われます。

field_search_strict: on # on | off
  • 既定値は off です(既存サイトの互換のため)。Ver. 3.2.36 以降を新規インストールした場合は、配布される config.system.yaml で on になっています。
  • on にすると、値を指定した検索ではヒットしなくなり、em(値が空のものを探す指定)ではヒットするようになります。
  • フィールド値の一覧(Field_ValueList、V2_Field_ValueList)にも同じ扱いが適用され、:search が 0 の値は一覧に出なくなります。
  • 管理画面には設定項目がありません。config.system.yaml で設定してください。

カスタムフィールドをキーにしたエントリーの表示順設定

カスタムフィールドの検索を行ったときに、検索結果のエントリーを指定した順番に表示する方法を説明します。(※カスタムフィールド検索については「カスタムフィールドの検索」をご覧ください)

1. 検索対象になるエントリーを用意する

まずは検索対象になるエントリーを用意します。エントリーを作成し、エントリーのカスタムフィールドを追加します。 ここでは例として、「price」というフィールドを用意し、いくつかエントリーを登録しておきます。 /themes/使用中のテーマ/admin/entry/field.html というファイルを作成します。 以下のソースを、/themes/使用中のテーマ/admin/entry/field.html にエントリーのカスタムフィールドを記述します。

<table class="entryFormTable acms-admin-table-entry">
  <tr>
    <th>価格</th>
    <td>
        <input type="text" name="price" value="{price}" size="10" /> 円
        <input type="hidden" name="field[]" value="price" />
        <input type="hidden" name="price:c" value="n" />
        <input type="hidden" name="price:validator#digits" />
        <!-- BEGIN price:validator#digits -->
        <p class="acms-admin-error-text">数値を入力してください。</p>
        <!-- END price:validator#digits -->
    </td>
  </tr>
</table>

エントリーのカスタムフィールドが作成できたら、作成したカスタムフィールドに値を入力し、[作成]ボタンをクリックし保存します。これを数回繰り返し、いくつかエントリーを登録します。 これで検索対象になるエントリーが用意できました。

2. カスタムフィールドをキーにした検索フォームを作成する

手順1で作成したカスタムフィールドをキーにした検索フォームを作成します。以下のソースは、フィールド「price」をキーにして検索するフォームです。

21行目にて、tplを「/index.html」と指定しているので、/themes/使用中のテーマ/index.html に検索フォームを設置してください。

<!-- BEGIN_MODULE Field_Search -->
<table>
  <th>演算子検索</th>
  <td>
    <form action="" method="post" class="acms-form">
      <!-- 宣言 -->
      <input type="hidden" name="field[]" value="price" />
       
      <!-- 演算子 -->
      <input type="hidden" name="price@operator" value="lte" />
       
      <p>価格
        <select name="price">
        <option value="">上限なし</option>
        <option value="300"{price:selected#300}>300円以下</option>
        <option value="200"{price:selected#200}>200円以下</option>
        <option value="100"{price:selected#100}>100円以下</option>
        </select>
      </p>
      <p>
        <input type="hidden" name="tpl" value="/index.html" />
        <input type="hidden" name="cid" value="%{CID}" />
        <input type="hidden" name="bid" value="%{BID}" />
        <input type="submit" name="ACMS_POST_2GET" value="検索する" class="acms-btn" />
      </p>
    </form>
  </td>
</table><!-- END_MODULE Field_Search -->

これでカスタムフィールドの値をキーにして検索するフォームができました。

3. エントリーを表示する順番を設定する

検索結果のエントリーの表示順を設定をする方法は3つあります。

  • (A)モジュールまたはモジュールIDのコンフィグ [優先度:低]
  • (B)モジュールIDの引数設定 [優先度:中]
  • (C) input要素での指定 [優先度:高]

(A)モジュールまたはモジュールIDのコンフィグ [優先度:低]

検索結果のエントリー表示にはモジュールを使用します。その使用するモジュールのコンフィグの「表示順」の設定で、以下の4つの中から選択します。

  1. フィールド(昇順)
  2. フィールド(降順)
  3. 数値フィールド(昇順)
  4. 数値フィールド(降順)

※ カスタムフィールドを「数値」として扱いたい場合は「数値フィールド」を選択します。

※ フィールドと数値フィールドの違い … 数値フィールドの昇順にすると、3、20、100…のように数値として小さい値から順になりますが、フィールドの昇順の場合、数値ではなく「文字列」として扱われるため、100、20、3…のようにアルファベット順になります。アルファベット順の昇順の場合、1が2より先にくるためです。


表示順をフィールド(昇順)に設定する

Entry_Bodyの表示順設定


なお、モジュールIDを使って、検索内容を表示する場合は「フィールド」の引数にチェックをつけてください。チェックをつけることで、検索内容と一致するものが表示されます。


モジュールIDの設定には引数にチェックをつける

モジュールIDの設定には引数にチェックをつける


(B)モジュールIDの引数設定 [優先度:中]


検索結果のエントリー表示で使用しているモジュールIDの引数設定で、以下の4つの中から設定します。

表示順意味
field-ascフィールド(昇順)
field-descフィールド(降順)
intfield-asc数値フィールド(昇順)
intfield-desc数値フィールド(降順)

モジュールIDの引数設定の例

モジュールIDの引数設定の例


※ カスタムフィールドを数値として扱いたい場合は「intfield-asc」「intfield-desc」を使用します。


(C)input要素を使った指定 [優先度:高]

手順2で作成したフォームのsubmitボタンの記述部分に、表示順を指定する記述を追加します。この記述の情報はURLコンテキストに反映されるため、指定を反映させるにはモジュールIDの引数設定にチェックを入れてください。

表示順を設定する記述

<input type="hidden" name="order" value="表示順" />
表示順意味
field-ascフィールド(昇順)
field-descフィールド(降順)
intfield-asc数値フィールド(昇順)
intfield-desc数値フィールド(降順)

今回の例では、価格は数値として扱い降順に表示する場合は、以下のような記述と設定になります。

<input type="hidden" name="order" value="intfield-desc" />
<input type="hidden" name="tpl" value="search" />
<input type="hidden" name="cid" value="%{CID}" />
<input type="hidden" name="bid" value="%{BID}" />
<input type="submit" name="ACMS_POST_2GET" value="検索する" class="acms-btn" />

モジュールIDの引数設定にチェックを入れる

モジュールIDの引数設定にチェックを入れる


表示順のチェックと表示順指定を両方設定した場合


引数設定の表示順で、表示順のチェックと表示順指定を両方設定すると、URLコンテキストに表示順の情報があるときにはURLコンテキストが優先され、URLコンテキストに表示順の情報がないときに、引数設定に入力した表示順が適用されます。


引数設定にチェックと表示順指定を両方入力した場合

引数設定にチェックと表示順指定を両方入力した場合


以上で、エントリーをソート表示する検索フォームができました。


表示順設定の優先度について

先述の(A)〜(C)の3つの表示順設定が、(A)〜(C)いずれか1つではなく重複している場合は、優先度がより高いものが適用されます。

表示順の設定の使い分け

基本的には「(A)モジュールまたはモジュールIDのコンフィグ」で説明した設定で表示順 を設定します。1ページに複数の検索フォームがある場合で、それぞれのフォームによって検索結果の表示順を変えたいときは、「(B)モジュールIDの引数設定」 か、「(C)input要素を使った指定」で指定します。

表示されていないカスタムフィールドの値を削除しないようにする

通常、エントリーデータの変更時にはカスタムフィールドの値は全て更新が行われます。そのエントリーに登録されているカスタムフィールドの値を全て削除したのちに、入力されている値を登録します。
例えば、新規エントリー登録時には、カスタムフィールドとしてTEL、FAXの項目にデータを入力して保存します。誤って編集時はカスタムフィールドのTEL、FAXの項目を記述しておらず、保存してしまいました。本来ならカスタムフィールドが無い状態で保存したため先ほど入力したTELとFAXの値は消えてしまいますが、下記の記述をするとカスタムフィールドの値が削除されないようになります。
エントリーのカスタムフィールドだけではなく、カテゴリーやブログのカスタムフィールドも同様に値を保持することができます。

全て削除してから登録するのではなく、画面に存在している値のみ上書きするには、下記の2行を入力・編集画面のformブロック内に記述します。

<input type="hidden" name="updateField" value="on" />
<input type="hidden" name="field[]" value="updateField" />

読者登録機能のカスタマイズ【~ Ver. 3.0】

この機能は Ver. 3.1 で廃止されました。新しい会員機能についてのドキュメントは以下をご覧ください。

ログイン・会員機能の基本


読者登録機能のカスタマイズ方法について解説します。

  • 読者登録の項目を増やす方法
  • 読者登録時のデフォルトユーザー権限を変える方法
  • 読者登録後、送られてきたメールのURLをクリックしなくても認証できる方法

読者登録機能を有効にしましょう

読者登録機能を使うことで自由にユーザーを登録することができます。ショッピングや会員サイトなどで使われています。
読者登録機能は管理画面にログインしていただきコンフィグ一覧 > ログイン設定 のページ内、読者登録機能の「ユーザー登録の外部申請:ユーザー登録の外部申請を受け付ける」にチェックをしてください。


ユーザー登録の外部申請を受け付けるにチェック

ユーザー登録の外部申請を受け付けるにチェック


ログイン画面の読者登録ボタン

ログイン画面の読者登録ボタン


読者登録機能を有効にすると http://a-blog cms設置先/login/ にアクセスしたときに「新規の読者登録はこちら」というリンク先ができています。



読者登録の項目を増やす方法


読者登録の項目に名前とメールアドレスという項目があります。ここに項目を増やしていきましょう。項目はカスタムフィールドを使って増やすことができます。
読者登録のテンプレートは /themes/system/login.html に記述されています。 /themes/system/login.html をご利用のテーマにコピーしましょう。
/themes/ご利用のテーマ/login.html

読者登録はsubscribeブロック内にあります。ここに追加したい項目のカスタムフィールドを追加しましょう。
登録画面のスクリーンショットはデフォルトレイアウトのままですが、login.htmlにHTMLやCSSを追加することでレイアウトの調整も出来ると思います。オリジナルデザインのユーザー登録画面を作成してください。

<!-- BEGIN subscribe -->
<div class="acms-titleBox"><!-- BEGIN_MODULE Blog_Field --><!-- BEGIN_IF [{loginHeaderImage@path}/nem/] --><!-- BEGIN loginHeaderImage:veil --><img class="acms-loginHeaderImage" src="%{ARCHIVES_DIR}{loginHeaderImage@path}" alt="%{BLOG_NAME}"><!-- END loginHeaderImage:veil --><!-- ELSE --><img class="acms-loginHeaderImage" src="/images/ablogcms_login.gif" alt="a-blog cms">
<!-- END_IF --><!-- END_MODULE Blog_Field --></div>
<div class="acms-loginBox">
<div class="acms-siteImageText"><span class="acms-label" style="background-color:%{BLOG_THEME_COLOR};">%{BLOG_NAME}</span>&nbsp;<span class="acms-label">新規読者登録</span></div>
<!-- BEGIN sendMsg#before -->
<p class="acms-login-text">お名前とメールアドスを登録いただくと指定されたメールアドレスに確認メールが送信されます。メールの内容の従って登録をしてください。</p><!-- END sendMsg#before --><!-- BEGIN sendMsg#after -->
<p class="acms-alert acms-alert-info">入力されたメールアドレス宛に、確認用URLをパスワードを記載したメールを送信しました。</p><!-- END sendMsg#after -->

<label for="input-text-mail" class="validator-result-{name:validator#required} acms-alert acms-alert-danger">名前が入力されていません。</label>
<label for="input-text-mail" class="validator-result-{mail:validator#required} acms-alert acms-alert-danger">メールアドレスが入力されていません。</label>
<label for="input-text-mail" class="validator-result-{mail:validator#email} acms-alert acms-alert-danger">不正なメールアドレスです。</label>
<label for="input-text-mail" class="validator-result-{mail:validator#doubleMail} acms-alert acms-alert-danger">すでに登録されているメールアドレスです。</label>
<label for="input-text-mail" class="validator-result-{mail:validator#send} acms-alert acms-alert-danger">メールの送信に失敗しました。システムの設定に問題があります。システムの管理者にお問い合わせください。</label>

<div class="acms-form">
  <label class="acms-form-block acms-clear">名前</label>
  <input type="text" name="name" value="{name}" class="acms-form-large  acms-form-block validator-result-{name:validator#required} acms-sp-form-top" placeholder="" />
  <input type="hidden" name="user[]" value="name" />
  <input type="hidden" name="name:validator#required" />
  <label class="acms-form-block acms-clear">メールアドレス</label>
  <input type="text" name="mail" value="{mail}" class="acms-form-large  acms-form-block validator-result-{mail:validator#required} validator-result-{mail:validator#email} validator-result-{mail:validator#doubleMail} validator-result-{mail:validator#send} acms-sp-form-bottom" placeholder="" />
  <input type="hidden" name="user[]" value="mail" />
  <input type="hidden" name="mail:validator#required" />
  <input type="hidden" name="mail:validator#email" />
  <input type="hidden" name="mail:validator#doubleMail" />
</div>

<!-- BEGIN submit -->
<p class="loginAction">
  <button type="submit" class="acms-btn-admin acms-btn-admin-primary acms-btn-block acms-btn-large" name="ACMS_POST_Login_Subscribe">読者登録</button>
</p><!-- BEGIN_MODULE Touch_SnsLogin -->
<p class="acms-border"><span class="acms-borderText acms-login-text">もしくは</span></p>
<p class="acms-login-text">SNSアカウントで登録するとワンクリックでログインできます。</p>
<p class="loginAction acms-login-facebook acms-btn-snsloginContainer">
  <span class="acms-btn-snsimage acms-btn-snsimage-facebook">
    <span class="acms-icon acms-icon-facebook"></span>
  </span>
  <button type="submit" class="acms-btn-admin acms-btn-facebooklogin acms-btn-block acms-btn-large acms-btn-snslogin" name="ACMS_POST_Api_Facebook_OAuth_Login">読者登録</button>
</p>
<p class="loginAction acms-login-twitter acms-btn-snsloginContainer">
  <span class="acms-btn-snsimage acms-btn-snsimage-twitter">
    <span class="acms-icon acms-icon-twitter"></span>
  </span>
  <button type="submit" class="acms-btn-admin acms-btn-twitterlogin acms-btn-block acms-btn-large acms-btn-snslogin" name="ACMS_POST_Api_Twitter_OAuth_Login">読者登録</button>
</p>
<!-- END_MODULE Touch_SnsLogin -->
<input type="hidden" name="type" value="signup" />
<!-- END submit -->
<p class="loginLink">
  <a href="/login/">ログイン画面に戻る</a>
</p>
</div>
<!-- END subscribe -->

今回は会社名と好きな果物の項目を追加しました。
他にも電話番号、住所、職種、性別など必要な項目を増やしてください。

<label class="acms-form-block acms-clear">会社名</label>
<input type="text" name="company" value="{company}" class="acms-form-large  acms-form-block" />
<input type="hidden" name="field[]" value="company" />
<label class="acms-form-block acms-clear">好きな果物 :</label>
<select class="formSelect" name="fruit">
  <option value="" selected="selected">選択してください</option>
  <option value="りんご"{fruit:selected#りんご}>りんご</option>  
  <option value="ぶどう"{fruit:selected#ぶどう}>ぶどう</option>
  <option value="みかん"{fruit:selected#みかん}>みかん</option>
</select>
<input type="hidden" name="field[]" value="fruit" />

読者登録画面

読者登録画面


読者登録申請 メールのテンプレートに項目を追加する

読者登録すると申請メールが届きます。このメールのテンプレートに先ほど追加した「会社名」と「好きな果物」の項目を記述してください。
メールのテンプレートはsystemテーマにあるのでご利用のテーマにコピーしてきてください。
/themes/system/mail/subscribe/subject.txt
/themes/system/mail/subscribe/body.txt
/themes/system/mail/subscribe/adminSubject.txt
/themes/system/mail/subscribe/adminBody.txt

ご利用のテーマ内にコピーしてきたbody.txtとadminBody.txtを開いて、「会社名」と「好きな果物」の項目を追加します。
/themes/ご利用のテーマ/mail/subscribe/body.txt
/themes/ご利用のテーマ/mail/subscribe/adminBody.txt

読者登録の申請を行いました。

名前 : {name}
パスワード : {pass}
会社名 : {company}
好きな果物 : {fruit}

以下のリンクをクリックし、メールアドレス、パスワードを入力してログインして下さい。
{subscribeUrl}[raw]

ユーザー管理画面のテンプレートに項目を追加する

次にユーザー管理画面にも「会社名」と「好きな果物」の項目を追加していきましょう。
ご利用のテーマのadminフォルダ内にuserフォルダを作成してください。その中にfield.htmlファイルを作りましょう。
/themes/ご利用のテーマ/admin/user/field.html

<table class="adminTable acms-table-admin-edit">
  <tr>
    <th>会社名</th>
    <td>
      <input type="text" name="company" value="{company}" />
      <input type="hidden" name="field[]" value="company" />
    </td>
  </tr>
  <tr>
    <th>好きな果物</th>
    <td>
      <select name="fluit">
        <option value=""></option>
        <option value="りんご"{fluit:selected#りんご}>りんご</option>
        <option value="ぶどう"{fluit:selected#ぶどう}>ぶどう</option>
        <option value="みかん"{fluit:selected#みかん}>みかん</option>
      </select>
      <input type="hidden" name="field[]" value="fluit" />
    </td>
  </tr>
</table>

実際に登録して、ユーザーの管理画面で確認してみましょう。
新しく追加した「会社名」と「好きな果物」が追加されています。


ユーザーのカスタムフィールド

ユーザーのカスタムフィールド


読者登録のデフォルトユーザー権限を変える方法

読者登録ですがVer.1.6.0からユーザー登録した人の権限を読者だけでなく「投稿者」「編集者」を設定できるようになりました。投稿者を読者登録画面から申請することができます。
※この機能はスタンダードライセンスだとユーザー数は基本5userまでなので、無制限ユーザー追加オプションやプロフェッショナル/エンタープライズ版を利用している方におすすめします。

この機能の設定は管理画面 コンフィグ一覧 > ログイン設定 のページ内、読者登録機能の「権限」という項目になります。ここでユーザー登録申請されたときにデフォルトで作成されるユーザーの権限を選択してください。


外部申請時の権限を変更する

外部申請時の権限を変更する


読者登録後、送られてきたメールのURLをクリックしなくても認証できる方法

読者登録は申請するとメールアドレスとパスワードの書いてあるメールのが届き、そのURLからログイン画面でメールアドレスとパスワードを入れることで初めてユーザー登録が完了します。
この機能を使うことで読者登録を申請するだけでユーザー登録ができます。
管理画面 コンフィグ一覧 > ログイン設定 のページ内、読者登録機能の「メールアドレスの有効性確認:メールアドレスの有効性とパスワード認証を行わない」にチェックをすると申請確認メールのメールアドレスとパスワードをクリックしなくてもユーザー登録ができるようになります。


「メールアドレスの有効性確認:メールアドレスの有効性とパスワード認証を行わない」にチェックをする

「メールアドレスの有効性確認:メールアドレスの有効性とパスワード認証を行わない」にチェックをする

カスタムフィールド定義の概要


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

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

Ver. 3.3.0 では、管理画面の「フィールド定義」で、カスタムフィールドの入力項目を定義できます。定義すると、エントリーなどの編集画面に入力欄が自動で出ます。テンプレートに入力欄の HTML を書く必要はありません。

管理画面の「フィールド定義」。対象ごとのタブと、フィールドセットの一覧
管理画面の「フィールド定義」。対象ごとのタブと、フィールドセットの一覧

値は、従来のカスタムフィールドと同じテーブルに、定義したキーで保存されます。そのため、公開側のテンプレートは従来と同じ {キー} の書き方で値を出せます。

できること

  • 管理画面で、入力項目の追加・編集・複製・削除・並び替えができます。

  • テキスト・選択肢・日付・数値のほか、メディア、エントリー・カテゴリー・ユーザーの参照、ブロックエディター、地図などの型を選べます(型の一覧)。

  • 必須を「任意」「保存時に必須」「公開時に必須」から選べます。必須と入力チェックは、サーバー側でも必ず確かめます。

  • カテゴリーなどの条件でフィールドセットを出し分けたり、ほかのフィールドの値によってフィールドを出し入れしたりできます。

  • 権限・ロールごとに、編集できる・読み取り専用・表示しないを決められます。

  • 行(横並び)・タブ・アコーディオンで入力欄を整理し、エントリーでは本文の上・本文の下・サイドバーに出し分けられます。

  • 繰り返し入力する項目(フィールドグループ)や、使い回せるフィールドの組(コンポーネント)を作れます。

  • 定義を JSON でエクスポート・インポートしたり、テーマに置いて配布したりできます。

  • プラグインから、独自のフィールド型や表示する場所を足せます。

従来のカスタムフィールドとの違い

従来のカスタムフィールドは、テーマのテンプレート(admin/entry/field.html など)に入力欄の HTML を書いて作ります。カスタムフィールド定義は、定義を管理画面(データベース)か、テーマの JSON ファイルに持ちます。

従来のカスタムフィールド

カスタムフィールド定義

定義の置き場所

テーマのテンプレート

管理画面(データベース)、またはテーマの JSON ファイル

入力欄

HTML を書く(カスタムフィールドメーカーで生成できます)

編集画面に自動で出ます

値の保存先

カスタムフィールドのテーブル

同じ(定義したキーで保存します)

公開側での出し方

{キー} など

同じ

必須・入力チェック

テンプレートに :v# で書きます

定義に設定します。サーバー側で必ず確かめます

繰り返し

@グループ名 の宣言とメンバーを HTML で書きます

型「フィールドグループ」で作ります。保存の形は同じです

2 つの方式は併用できます。既存のテンプレートは、そのまま動き続けます。同じキーを両方に書いたときの扱いや、従来のフィールドを定義へ移す手順は「従来のカスタムフィールドとの併用と移行」を参照してください。

用語

用語

意味

フィールドセット

フィールド定義をまとめる単位です。表示条件(どの画面で出すか)と、表示する場所を持ちます。

フィールド定義(フィールド)

入力項目 1 つ分の定義です。キー・ラベル・型・必須・入力チェックなどを持ちます。

キー

値を保存する名前です。テンプレートでは {キー} で出します。

フィールドグループ

同じ形の入力を何項目も繰り返す仕組みです。従来のカスタムフィールドグループと同じ形で保存します。フィールドセットとは別のものです。

コンポーネント

いくつかのフィールドの組に名前を付け、ほかのフィールドセットから使い回せるようにしたものです。

テーマ由来の定義

テーマの JSON ファイルで宣言した定義です。管理画面では編集できません。

継承

親ブログのフィールドセットを、子孫のブログでも使えるようにすることです。

派生キー

キー@path のように、@ で始まる接尾辞を付けたキーです。メディアや参照の型で使います。

対象

定義を作れる対象は、エントリー・カテゴリー・ブログ・ユーザー・モジュールの 5 つです。定義画面の上部のタブで、対象を切り替えます。タブにはほかに「コンポーネント」があります。

対象

編集画面で入力欄が出る位置

エントリー

本文の上(標準)。フィールドセットごとに、本文の下・サイドバーも選べます

カテゴリー・ブログ・ユーザー

「カスタム設定」タブの中。テンプレートで作ったカスタムフィールドの後ろに出ます

モジュール

モジュール ID の編集画面の「カスタム設定」タブの中。モジュール ID の設定で「カスタムフィールドを表示」にチェックしたものだけに出ます

エントリーの編集画面。定義したフィールドが本文の上に出ます
エントリーの編集画面。定義したフィールドが本文の上に出ます

ユニット(カスタムユニット)とフォームの項目は、対象ではありません。

エディションと権限

次の型と機能は、プロフェッショナルライセンス以上で使えます。

  • 型「隠し値(hidden)」「メディアギャラリー」「地図」

  • フィールドグループの設定「項目ごとにブロックを 1 つ選ぶ」

スタンダードライセンスでは、型を選ぶ画面に「Pro」の印が付き、選べません。テーマやインポートで入ったこれらの定義は「プロフェッショナルライセンス以上が必要(読み取り専用)」と表示され、編集できません。

定義画面は、管理画面のメニュー「フィールド定義」から開きます。開ける人は次のとおりです。

  • ロールを使っていないユーザー: そのブログの管理者の権限があれば開けます。

  • ロールを使っているユーザー: ロールの設定で「フィールド定義の編集」にチェックが入っていれば開けます。

プレビュー中は開けません。

このドキュメントの読み方

はじめての方は「はじめてのフィールド定義」で、定義から公開側の表示までを一通り試してください。

ページ

内容

はじめてのフィールド定義

定義を作り、編集画面で入力し、テンプレートで出すまでの通しの手順

フィールドセットの作成と設定

フィールドセットの作成、表示する場所、表示条件

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

フィールドの追加、必須、入力チェック、条件付き表示、権限・ロール別の表示

入力の型の設定(文字・選択・日付・数値)

テキスト・選択肢・日付・数値などの型の設定

メディア・参照・地図・アップロード・ブロックエディターの型の設定

メディア・参照・地図・アップロード・ブロックエディターの型の設定

レイアウトの型(見出し・メッセージ・行・タブ・アコーディオン)

見出し・メッセージ・行・タブ・アコーディオン

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

繰り返し入力する項目

コンポーネント

フィールドの組の使い回し

項目ごとにブロックを選ぶフィールドグループ

項目ごとに形の違う入力を並べる

テンプレートでの出力(基本の型)

基本の型のテンプレートの書き方

テンプレートでの出力(メディア・参照・地図・アップロード)

メディア・参照・地図などのテンプレートの書き方

テーマでフィールド定義を宣言する

テーマの JSON で定義を配布する

テーマでパターン・独自の型・表示する場所を足す

テーマでパターン・独自の型・表示する場所を足す

従来のカスタムフィールドとの併用と移行

従来のカスタムフィールドとの併用、移行の手順

よくあるつまずきと注意点

うまくいかないときの確認点

プラグインからの拡張

プラグインからの拡張(Hook・登録口・JS イベント)

はじめてのフィールド定義


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

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

このページでは、エントリーにイベントの情報(開催日・会場・種類)を入力できるようにし、エントリーの詳細ページに表示します。画面の操作は、管理者の権限を持つユーザーで行います。

フィールドセットを作る

管理画面の「フィールド定義」で、対象「エントリー」のフィールドセットを追加します。ラベルは イベント情報、コードは event とし、有効にして追加します。追加したフィールドセットの編集画面で、フィールドを追加します。

フィールドを追加する

開催日・会場・種類の 3 つを追加します。

  • 型「日付」: キー cf_event_date、ラベル「開催日」、必須入力「公開時に必須」(キーの欄には cf_ が最初から入っています)。

  • 型「テキスト」: キー cf_event_place、ラベル「会場」。

  • 型「セレクトボックス」: キー cf_event_type、ラベル「種類」。選択肢は、値 seminar・表示名「セミナー」と、値 workshop・表示名「ワークショップ」の 2 つ。

キーはテンプレートで使う名前です

キーは追加した後は変えられません(変えるときは「キーを変更」を使います)。半角英字かアンダースコアで始め、半角英数字とアンダースコアで入力します。

編集画面で入力する

エントリーの編集画面を開くと、本文(ユニット)の上に「開催日」「会場」「種類」の入力欄が出ます。値を入力して保存します。

エントリーの編集画面に出た「イベント情報」の入力欄
エントリーの編集画面に出た「イベント情報」の入力欄

「開催日」は「公開時に必須」にしたため、ステータスを公開にして保存するときだけ、空だとエラーになります。下書きなら空のまま保存できます。

テンプレートで表示する

エントリーの詳細ページのテンプレートに、次のように書きます。値は {キー} で出します。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_event_date:veil -->
<dl class="event-info">
  <dt>開催日</dt>
  <dd>{cf_event_date}[date('Y年n月j日')]</dd>
  <dt>会場</dt>
  <dd>{cf_event_place}</dd>
  <dt>種類</dt>
  <dd><!-- BEGIN_IF [{cf_event_type}/eq/seminar] -->セミナー<!-- ELSE_IF [{cf_event_type}/eq/workshop] -->ワークショップ<!-- END_IF --></dd>
</dl>
<!-- END cf_event_date:veil -->
<!-- END_MODULE Entry_Field -->
  • Entry_Field は、表示しているエントリーのカスタムフィールドを出すモジュールです。エントリーの一覧や本文のモジュール(Entry_Body など)では、従来どおり entry:loop の中に書きます。

  • <!-- BEGIN cf_event_date:veil --> は、開催日に値があるときだけ中を出します。

  • セレクトボックスは選んだ「値」を保存します。表示名を出すときは、値で分岐して書きます。

Twig のテンプレートでは、次のように書きます。

{% set f = module('V2_Entry_Field').fields %}
{% set typeLabels = {'seminar': 'セミナー', 'workshop': 'ワークショップ'} %}
{% if f.cf_event_date.value %}
<dl class="event-info">
  <dt>開催日</dt>
  <dd>{{ f.cf_event_date.value|date('Y年n月j日') }}</dd>
  <dt>会場</dt>
  <dd>{{ f.cf_event_place.value }}</dd>
  <dt>種類</dt>
  <dd>{{ typeLabels[f.cf_event_type.value] ?? '' }}</dd>
</dl>
{% endif %}

カテゴリーで出し分ける

イベント情報を「event」カテゴリーのエントリーだけに出すには、フィールドセットに表示条件を付けます。

フィールドセットの編集画面の「フィールドセットの設定」で、「表示条件」に「カテゴリー」が「のいずれかと等しい」の条件を追加し、「event」カテゴリーを選んで保存します。子カテゴリーのエントリーにも出すときは、範囲を「それと配下すべて」に変えます。

エントリーの編集画面で、カテゴリーを「event」にしたときだけ入力欄が出ることを確かめます。

次に読むページ

フィールドセットの作成と設定


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

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

フィールドセットは、フィールド定義をまとめる単位です。編集画面では、フィールドセットごとに出すかどうかと、出す場所が決まります。

フィールドセットを作る

管理画面の「フィールド定義」で対象(「エントリー」「カテゴリー」「ブログ」「ユーザー」「モジュール」)を選び、フィールドセットを追加します。ラベルとコードを入力し、必要なら説明・有効・継承を設定します。追加したフィールドセットにフィールドを追加します(フィールドの追加と共通の設定)。

対象ごとに、コードが default の既定のフィールドセットがあります。既定のフィールドセットは削除できず、コードも変えられません。

設定項目

フィールドセットの編集画面の左にある「フィールドセットの設定」で変更し、「設定を保存」を押します(変更が無いときは「保存済み」と表示されます)。

フィールドセットの編集画面の「フィールドセットの設定」
フィールドセットの編集画面の「フィールドセットの設定」

項目

内容

既定値

入力例

ラベル

一覧に出す名前です。必須です。

—

イベント情報

コード

同じ対象の中で重ならない名前を、半角英数字とアンダースコアで入力します(64 文字以内)。エクスポート・テーマの宣言では、このコードで同じフィールドセットかを判断します。

—

event

説明

フィールドセットの説明です。

空

イベントの開催情報

有効にする

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

—

—

子孫のブログにも継承する

子孫のブログの編集画面にも出します。子ブログでは、フィールドごとに「使わない」にできます。

オフ

—

表示する場所

エントリーで、入力欄を出す場所を選びます(後述)。

本文の上

本文の下

表示条件

どのカテゴリーなどのときに出すかを決めます(後述)。

条件なし(常に出す)

カテゴリーが news

表示する場所

エントリーでは、フィールドセットごとに入力欄を出す場所を選べます。

場所

名前

内容

本文の上

main

標準の位置です。テンプレートで作ったカスタムフィールドの後ろ、本文(ユニット)の上に出ます。

本文の下

foot

本文(ユニット)の下に出します。

サイドバー

side

編集画面のサイドバーに出します。幅が狭いので、短い入力向けです。表や繰り返しは、本文の上か下に置いてください。

エントリー以外の対象は、標準の位置だけです。テーマやプラグインで場所を足せます(テーマでパターン・独自の型・表示する場所を足す)。編集画面のテンプレートにその場所の差し込み口が無い場合、フィールドセットは標準の位置に出ます。

表示条件

フィールドセットを出す条件です。条件が無ければ常に出します。グループ内の条件をすべて満たす(かつ)か、いずれかのグループを満たす(または)ときに、編集画面に出します。

表示条件は、「項目」「条件」「値」の組です。同じグループの条件はすべて満たす(かつ)必要があり、別のグループを足すと、どれかを満たせば(または)出します。カテゴリー・ブログなど階層のある項目では、範囲として「そのもの」か「それと配下すべて」を選べます。「のいずれかと等しい」ではカテゴリーやブログを複数選べ、値が空のままでは保存できません。

使える項目は、対象によって決まっています。

項目の名前

画面の表示

使える対象

使える条件

範囲

blog

ブログ

すべて

のいずれかと等しい / と等しい / と等しくない

指定できます

category

カテゴリー

エントリー

のいずれかと等しい / と等しい / と等しくない / が空 / が空でない

指定できます

subCategory

サブカテゴリー

エントリー

のいずれかと等しい / が空 / が空でない

指定できます

entryCode

エントリーのコード

エントリー

と等しい / と等しくない / を含む / が正規表現に一致する / が空 / が空でない

—

parentCategory

親カテゴリー

カテゴリー

のいずれかと等しい / と等しい / と等しくない / が空

指定できます

categoryCode

カテゴリーのコード

カテゴリー

と等しい / と等しくない / を含む / が正規表現に一致する

—

parentBlog

親ブログ

ブログ

のいずれかと等しい / と等しい / と等しくない / が空

指定できます

blogCode

ブログのコード

ブログ

と等しい / と等しくない / を含む / が正規表現に一致する

—

userAuth

ユーザーの権限

ユーザー

のいずれかと等しい / と等しい / と等しくない

—

userCode

ユーザーのコード

ユーザー

と等しい / と等しくない / を含む / が正規表現に一致する

—

moduleName

モジュールの種類

モジュール

のいずれかと等しい / と等しい / と等しくない

—

moduleIdentifier

モジュールの ID

モジュール

と等しい / と等しくない / を含む / が正規表現に一致する

—

  • 「サブカテゴリー」は、サブカテゴリー機能を有効にしたブログだけで選べます。

  • 「ユーザーの権限」の値は「管理者」「編集者」「投稿者」「読者」から選びます。

  • 「項目の名前」は、テーマの JSON で条件を書くときに使います(テーマでフィールド定義を宣言する)。

権限・ロールで出し分けるには

表示条件には、編集する人の権限・ロールの項目はありません。権限・ロールで出し分けるときは、各フィールドの「権限・ロール別の表示」を使います(フィールドの追加と共通の設定)。

一覧での操作

フィールドセットは、並び替え・複製・エクスポート・削除ができます。並び順が編集画面での並び順になります。複製すると、ラベルは「(ラベル)のコピー」、コードは末尾に _copy が付きます。削除しても、入力済みの値は削除されません。

テーマ由来・親ブログ由来のフィールドセットには「テーマ」「親ブログ」の印が付き、並び替え・複製・削除はできません。

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


この機能は 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 など)の値は、新しい型では使いません。

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

入力の型の設定(文字・選択・日付・数値)


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

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

型ごとの設定は、フィールドの設定フォームの「高度な設定」の中にあります(選択肢など型の中心になる設定は、基本の欄に出ます)。すべての型に共通する設定は「フィールドの追加と共通の設定」を参照してください。表の「config のキー」は、テーマの JSON で書くときの名前です。

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

型のキーは text(1 行)と textarea(複数行)です。値はそのまま キー に保存されます。

設定項目(画面)

config のキー

内容

既定値

入力例

プレースホルダー

placeholder

空の入力欄に薄く出す例です。

空

例: 東京国際フォーラム

入力欄の前に表示するテキスト

prefix

入力欄の前に出すテキストです(10 文字まで)。値には含めません。

空

¥

入力欄の後ろに表示するテキスト

suffix

入力欄の後ろに出すテキストです(10 文字まで)。値には含めません。

空

円

最大文字数

maxLength

入力欄に入力できる文字数の上限です(テキストだけ)。サーバーで確かめるには、入力チェックの「最大文字数」も付けます。

制限なし

100

項目数

rows

入力欄の行数です(テキストエリアだけ)。

ブラウザの既定

5

文字数を表示する

showCharCount

入力中の文字数を表示します。

オフ

—

目安の文字数

recommendedLength

文字数の目安です。超えると赤で表示します(保存はできます)。

空

120

入力の変換

converter

保存時に値を変換します。mb_convert_kana のオプション(フォームの :converter と同じ)を入力するか、入力補助(「英数字・記号」「スペース」「かな・カタカナ」)で選びます。

空(変換しない)

as(英数字・記号とスペースを半角にそろえる)

前後のテキストはテキストだけにあります(テキストエリアにはありません)。

{ "key": "cf_summary", "label": "概要文", "type": "textarea",
  "config": { "rows": 4, "showCharCount": true, "recommendedLength": 120 },
  "validation": { "required": "none", "rules": [{ "method": "maxlength", "arg": "200" }] } }

セレクトボックス・チェックボックス・ラジオボタン

型のキーは select・checkbox・radio です。保存されるのは選んだ選択肢の「値」で、表示名は保存しません。

設定項目(画面)

config のキー

内容

既定値

入力例

選択肢

options

1 行に「値」と「表示名」を入力します。「選択肢を追加」で行を足し、つまみで並べ替えます。表示名が空なら値を出します。

なし

値 seminar、表示名 セミナー

複数選択できるようにする

multiple

セレクトボックス・チェックボックスで、複数の値を選べるようにします。

セレクトボックスはオフ、チェックボックスはオン

—

未選択のときの表示

emptyLabel

セレクトボックスの先頭の、空の選択肢に出す文字です。

空

選択してください

チェック時の値

checkedValue

チェックボックスを複数選択にしないとき(単一の on/off)に、チェックしたときに保存する値です。

on

1

型と設定

保存される値

編集画面

セレクトボックス(単一)

キー に 1 つの値

プルダウン

セレクトボックス(複数選択)

キー に複数の値

複数を選べるリスト

チェックボックス(複数選択。既定)

キー に、チェックした値を並べて保存

選択肢の数だけチェックボックス

チェックボックス(単一の on/off)

キー に「チェック時の値」。外すと空

チェックボックス 1 つ

ラジオボタン

キー に 1 つの値

選択肢の数だけラジオボタン

  • ラジオボタンの最初の選択は、共通の設定「初期値」に選択肢の値を入れて指定します。

  • 保存時に、値が選択肢にあるかをサーバーで確かめます。選択肢を後から減らしても、保存済みの値は消えずに残り、編集画面に「選択肢に無い値」と表示されます。

  • 複数の値を持つ型(複数選択のチェックボックス・セレクトボックス)は、フィールドグループの中に置けません。

{ "key": "cf_features", "label": "特徴", "type": "checkbox",
  "config": { "options": [ { "value": "parking", "label": "駐車場あり" }, { "value": "wifi", "label": "Wi-Fi あり" } ] },
  "validation": { "required": "none", "rules": [{ "method": "all_maxChecked", "arg": "2" }] } }

日付・時刻・日時

型のキーは date・time・datetime です。カレンダー(flatpickr)で選び、「表示フォーマット」の形の文字列で保存します。

設定項目(画面)

config のキー

内容

既定値

入力例

表示フォーマット

format

保存・表示する形です。flatpickr の書式で指定します。秒を入れるときは H:i:S にします。

日付 Y-m-d、時刻 H:i、日時 Y-m-d H:i

Y/m/d

選択できる最小日

minDate

日付だけ。これより前の日を選べなくします。

制限なし

2026-01-01

選択できる最大日

maxDate

日付だけ。これより後の日を選べなくします。

制限なし

2026-12-31

  • 保存時に、値が「表示フォーマット」で読めるかをサーバーで確かめます。

  • テンプレートで並べ替えや日付の整形をしやすくするため、フォーマットは既定の Y-m-d のままにすることを勧めます。表示の形は校正オプション [date(...)] で変えられます(テンプレートでの出力(基本の型))。

数値

型のキーは number です。値は キー に保存されます。

設定項目(画面)

config のキー

内容

既定値

入力例

プレースホルダー

placeholder

空の入力欄に薄く出す例です。

空

1000

小数部の桁数

decimals

小数部の桁数の上限です。空欄は制限なし、0 は整数だけです(上限 10)。全角の数字や 3 桁区切りは、保存時に半角の数値に直します。桁を超えた値は丸めずに入力エラーにします。

制限なし

2

入力欄の前に表示するテキスト

prefix

入力欄の前に出すテキストです(10 文字まで)。値には含めません。

空

¥

入力欄の後ろに表示するテキスト

suffix

入力欄の後ろに出すテキストです(10 文字まで)。値には含めません。

空

円

  • 保存時に、値が数値かをサーバーで確かめます。

  • 範囲は、入力チェックの「下限値」「上限値」で指定します。

  • 末尾の 0 は埋めません(1.5 は 1.5 のまま保存します)。桁をそろえて出すときは、テンプレートで [number_format(2)] を使います(1500.5 は 1,500.50)。[number_format] だけだと小数点以下は四捨五入されます(1,501)。

電話番号・メールアドレス・URL

型のキーは tel・email・url です。値は キー に保存されます。

設定項目(画面)

config のキー

内容

既定値

入力例

プレースホルダー

placeholder

空の入力欄に薄く出す例です。

空

03-1234-5678

入力欄の前に表示するテキスト

prefix

入力欄の前に出すテキストです(10 文字まで)。値には含めません。

空

¥

入力欄の後ろに表示するテキスト

suffix

入力欄の後ろに出すテキストです(10 文字まで)。値には含めません。

空

円

入力の変換

converter

保存時に値を変換します。mb_convert_kana のオプション(フォームの :converter と同じ)を入力するか、入力補助(「英数字・記号」「スペース」「かな・カタカナ」)で選びます。

空(変換しない)

as(英数字・記号とスペースを半角にそろえる)

  • メールアドレス・URL は、保存時に形式をサーバーで確かめます。

  • 電話番号は形式を確かめません。決まった形にしたいときは、入力チェックの「正規表現マッチ」か「数字チェック」を付けます。

隠し値(hidden)

型のキーは hidden です。プロフェッショナルライセンス以上で使えます。編集画面には入力欄を出さずに、値を保存します。

設定項目(画面)

config のキー

内容

既定値

入力例

初期値

defaultValue

新規のときに入る値です。テンプレートの変数は展開せず、そのまま保存します。

空

v1

  • 必須・入力チェックは設定できません。

  • 検索対象の既定はオフです。

  • 値は画面から送られるため、書き換えられる可能性があります。信頼が要る値は、プラグインの Hook extendsFieldDefinitionValue でサーバー側に決めさせます(プラグインからの拡張)。

  • フィールドグループの中には置けません。

メディア・参照・地図・アップロード・ブロックエディターの型の設定


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

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

このページの型は、値と一緒に キー@media などの派生キーを保存します。テンプレートでの出し方は「テンプレートでの出力(メディア・参照・地図・アップロード)」を参照してください。

メディア画像・メディアファイル

型のキーは media-image・media-file です。メディアライブラリから選ぶか、アップロードして選びます。

設定項目(画面)

config のキー

内容

既定値

入力例

許可する拡張子(カンマ区切り)

allowedExtensions

選べるメディアの拡張子です。空欄なら制限しません(メディア画像は画像、メディアファイルはファイルから選びます)。

空

jpg,png,webp

サムネイルの幅(px)

thumbnailWidth

メディア画像だけ。編集画面のプレビューの幅です。

既定の幅

240

保存されるキー

内容

キー・キー@media

メディアの ID

  • @path・@alt などの値は保存せず、表示のたびにメディアライブラリの情報から作ります。メディアの代替テキストなどを直すと、表示も変わります。

  • 代替テキストが空の画像には、編集画面で「alt なし」の印が出ます。

  • テンプレートでは、メディア画像の @path の前に %{MEDIA_ARCHIVES_DIR} を付けます。メディアファイルの @path は /media-download/… から始まるので、何も付けません。

メディアギャラリー

型のキーは media-gallery です。プロフェッショナルライセンス以上で使えます。画像を複数選び、並べ替えられます。

設定項目(画面)

config のキー

内容

既定値

入力例

許可する拡張子(カンマ区切り)

allowedExtensions

選べる画像の拡張子です。

空

jpg,png

並べ替えを許可する

allowReorder

編集画面で並べ替えられるようにします。

オン

—

サムネイルの幅(px)

thumbnailWidth

編集画面のプレビューの幅です。

既定の幅

160

最大枚数

(入力チェック all_maxChecked)

選べる枚数の上限です。空欄は無制限です。

無制限

10

キー・キー@media にメディアの ID を、選んだ順に複数保存します。標準のテンプレートで画像を回すときは <!-- BEGIN キー@path:loop --> を使い、ループの中の {キー@alt} は空になります(代替テキストは {キー@alt[1]} のように添字で出すか、Twig を使います)。最小の枚数は、入力チェックの「最小選択数」で指定します。フィールドグループの中には置けません。

エントリー・カテゴリー・ユーザーの参照

ほかのエントリー・カテゴリー・ユーザーを選んで紐付けます。1 件を選ぶ型と、複数を選ぶ型があります。

型

型のキー

保存されるキー

エントリー参照

relation-entry

キー と キー@entry にエントリー ID

エントリー参照(複数)

relation-entries

同上(複数)

カテゴリー参照

relation-category

キー と キー@category にカテゴリー ID

カテゴリー参照(複数)

relation-categories

同上(複数)

ユーザー参照

relation-user

キー と キー@user にユーザー ID

ユーザー参照(複数)

relation-users

同上(複数)

設定項目(画面)

config のキー

内容

既定値

入力例

選択範囲のブログ ID(省略時は編集中のブログ)

scopeBlogId

このブログのものから選びます。

編集中のブログ

1

選択範囲のカテゴリー ID(そのカテゴリーに属するエントリーだけ。省略可)

scopeCategoryId

エントリー参照だけ。サブカテゴリーとしての所属も含みます。子孫のカテゴリーは含みません。

制限なし

3

選択できるステータス(省略時はすべて)

scopeStatus

エントリー参照だけ。「公開」「非公開」「下書き」(open・close・draft)。

すべて

公開

親カテゴリー ID(配下だけ選択。省略可)

scopeParentCategoryId

カテゴリー参照だけ。そのカテゴリーとその配下から選びます。

制限なし

5

選択できる権限(省略時はすべて)

scopeAuth

ユーザー参照だけ。「管理者」「編集者」「投稿者」(administrator・editor・contributor)。

すべて

編集者

並べ替えを許可する

allowReorder

複数を選ぶ型だけ。

オン

—

ユーザーのカスタムフィールドを公開側に出す

outputFields

ユーザー参照だけ。Twig・JSON(V2 モジュール)の出力に、参照先ユーザーのカスタムフィールドを含めます。公開してよい値だけのときに使ってください。

オフ

—

  • 件数の上限・下限は、入力チェックの「最大選択数」「最小選択数」で指定します(複数を選ぶ型)。

  • ブログのエクスポート・インポートでは、保存済みの参照先の ID を読み替えます。定義のエクスポート・インポートでは、選択範囲のブログ・カテゴリーの ID をコードで書き出し、取り込み先の ID に読み替えます。

  • 複数を選ぶ型は、フィールドグループの中に置けません。

地図

型のキーは map です。プロフェッショナルライセンス以上で使えます。地図をクリックしてピンを置くか、緯度・経度を入力します。

設定項目(画面)

config のキー

内容

既定値

入力例

地図の種類

provider

「OpenStreetMap」(osm)か「Google マップ」(google)。Google マップを使うには API キーの設定が要ります。

osm

Google マップ

初期表示の緯度

defaultLat

ピンが無いときに表示する位置です(値には保存しません)。緯度と経度の両方を入れたときだけ使い、空欄なら東京駅付近です。

空

35.6812

初期表示の経度

defaultLng

同上。

空

139.7671

初期表示のズーム

defaultZoom

同上。0〜21 の整数です。

空

15

住所検索を出す

search

住所で検索してピンを置けるようにします。入力した住所は、検索のために外部の地図サービスへ送信されます。

オン

—

ストリートビューを使えるようにする

streetView

Google マップを選んだときだけ使えます。

オフ

—

キー に「緯度,経度」(例: 35.6812000,139.7671000)を保存し、キー@lat・キー@lng・キー@zoom も保存します。検索対象の既定はオフです。フィールドグループの中には置けません。

アーカイブ画像・アーカイブファイル(ユーザーのみ)

型のキーは image・file です。ユーザーの定義でだけ選べます。ファイルをメディアライブラリを通さずに、アーカイブへ直接アップロードします。

設定項目(画面)

config のキー

内容

既定値

入力例

許可する拡張子(カンマ区切り)

allowedExtensions

カンマか空白で区切ります。サイトで許可された拡張子から指定でき、空欄ならすべて(画像はすべての画像)です。

空

jpg,png

大きさの上限(KB)

maxFileSize

空なら上限を設けません(サーバーの設定の上限は超えられません)。

空

2048

画像の大きさ(長辺 px)

size

アーカイブ画像だけ。空なら元の大きさのまま保存します。縮小のみで、拡大はしません。

空

1200

小さい画像(tiny。長辺 px)

tinySize

アーカイブ画像だけ。

空

280

大きい画像(large。長辺 px)

largeSize

アーカイブ画像だけ。

空

2400

正方形の画像(square。一辺 px)

squareSize

アーカイブ画像だけ。

空

300

代替テキストの欄を出す

altInput

アーカイブ画像だけ。

オフ

—

ダウンロード時のファイル名の欄を出す

downloadName

アーカイブファイルだけ。

オフ

—

従来の画像・ファイルのカスタムフィールドと同じ派生キー(@path など)で保存します。初期値はありません。検索対象の既定はオフです。フィールドグループ・コンポーネントの中には置けません。

ブロックエディター

型のキーは block-editor です。ブロックエディターで本文のような内容を組み立てます。値は HTML として キー に保存されます。

設定項目(画面)

内容

既定値

機能

斜体・下線・文字色などの装飾を、「編集画面セットのまま」「使う」「使わない」から選びます。

編集画面セットのまま

ブロック > 使えるブロック

チェックしたブロックだけを追加できます。何もチェックしなければ、編集画面セットのブロックエディター設定のブロックをすべて使えます。

すべて

ブロック > どのブロックも追加できなくする

ブロックを追加できなくします。

オフ

ブロック > 使えないブロック

チェックしたブロックを追加できなくします。

なし

このフィールド専用の一覧を使う

文字サイズ・フォント・クラス・画像のサイズ・カラーパレットなどの一覧を、このフィールドだけ変えます。無効のときは、編集画面セットのブロックエディター設定の一覧を使います。

オフ

これらの設定は、定義の config.settings に保存されます。テーマの JSON に書くときは、管理画面で設定してエクスポートした JSON を写すのが確実です。

レイアウトの型(見出し・メッセージ・行・タブ・アコーディオン)


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

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

レイアウトの型は値を保存しません。入力欄を整理するための型です。箱(行・タブの入れ物・タブ・アコーディオン)にフィールドを入れても出しても、中のフィールドのキーと保存される値、テンプレートの書き方は変わりません。

型の一覧

型

型のキー

置ける場所・中に置けるもの

設定(config のキー)

既定値

見出し

heading

どこにでも置けます。

なし(ラベルが見出し、説明が補足になります)

—

メッセージ

message

どこにでも置けます。

「本文」(body)、「スタイル」(style。「情報」info /「警告」warning)

スタイルは情報

行(横並び)

row

中にフィールドを置きます。

「列数」(columns。「2 列」2 /「3 列」3)。列幅を指定していない中のフィールドを、何列に並べるかです。

2

タブの入れ物

tabs

中に置けるのはタブだけです。

なし

—

タブ

tab

タブの入れ物の中にだけ置けます。中にフィールドを置きます。

なし

—

アコーディオン

accordion

中にフィールドを置きます。

「閉じて表示する」(collapsed)。最初は閉じた状態で表示します。中にエラーがあるときは開きます。

オフ(開く)

レイアウトの型も「キー」を持ちますが、値は保存しません。新しく追加するときは、キーが自動で付きます。行・タブの入れ物・アコーディオンは、フィールドグループの中にも置けます。

作る手順

行(横並び)に「店舗名」と「電話番号」を並べる例です。「レイアウト」の「行(横並び)」を、ラベル「名前と電話」・列数「2 列」で追加し、行の中にテキストのフィールド cf_shop_name(店舗名)と cf_shop_tel(電話番号)を追加します。すでにあるフィールドは、ドラッグで箱に入れられます。

タブは、先に「タブの入れ物」を追加し、その中に「タブ」を追加して、タブの中にフィールドを追加します。

定義の例

見出し・メッセージ・行・タブ・アコーディオンを使ったフィールドセットを、テーマの JSON で書いた例です(管理画面で同じものを作ってエクスポートしても、ほぼ同じ形になります)。中に入れるフィールドは parentKey で箱のキーを指します。

{
  "version": 1,
  "entityType": "entry",
  "sets": [
    {
      "code": "shop",
      "label": "店舗情報",
      "fields": [
        { "key": "shop_heading", "label": "店舗情報", "type": "heading", "description": "公開側の店舗ページに表示します。" },
        { "key": "shop_notice", "label": "お知らせ", "type": "message",
          "config": { "body": "営業時間が変わったときは、必ず更新してください。", "style": "warning" } },
        { "key": "shop_row", "label": "名前と電話", "type": "row", "config": { "columns": 2 } },
        { "key": "cf_shop_name", "label": "店舗名", "type": "text", "parentKey": "shop_row" },
        { "key": "cf_shop_tel", "label": "電話番号", "type": "tel", "parentKey": "shop_row" },
        { "key": "shop_tabs", "label": "詳細", "type": "tabs" },
        { "key": "shop_tab_hours", "label": "営業時間", "type": "tab", "parentKey": "shop_tabs" },
        { "key": "cf_shop_open", "label": "開店", "type": "time", "parentKey": "shop_tab_hours", "config": { "width": 50 } },
        { "key": "cf_shop_close", "label": "閉店", "type": "time", "parentKey": "shop_tab_hours", "config": { "width": 50 } },
        { "key": "shop_tab_access", "label": "アクセス", "type": "tab", "parentKey": "shop_tabs" },
        { "key": "cf_shop_access", "label": "アクセス", "type": "textarea", "parentKey": "shop_tab_access" },
        { "key": "shop_more", "label": "その他", "type": "accordion", "config": { "collapsed": true } },
        { "key": "cf_shop_note", "label": "備考", "type": "textarea", "parentKey": "shop_more" }
      ]
    }
  ]
}

編集画面での見え方

  • 見出し: ラベルを見出しとして出し、説明を補足として出します。

  • メッセージ: 本文を、スタイルに合わせた案内(情報・警告)として出します。

  • 行(横並び): 中のフィールドを横に並べます。列幅を指定したフィールドはその幅で、指定していないフィールドは列数で割った幅になります。狭い画面では縦に並びます。

  • タブの入れ物とタブ: 中のタブを 1 つのタブバーに並べます。選んでいないタブの中の入力も送信されます。エラーのあるタブの見出しには印が付きます。

  • アコーディオン: 中のフィールドを、開閉できる見出しの下にまとめます。中にエラーがあれば開きます。

レイアウトの型を使った編集画面
レイアウトの型を使った編集画面

保存されるキーとテンプレート

上の例で保存されるのは、cf_shop_name・cf_shop_tel・cf_shop_open・cf_shop_close・cf_shop_access・cf_shop_note だけです。shop_row などの箱のキーには値はありません。テンプレートでは、箱を意識せずにそのまま書きます。

<!-- BEGIN_MODULE Entry_Field -->
<h2>{cf_shop_name}</h2>
<p>電話: <a href="tel:{cf_shop_tel}">{cf_shop_tel}</a></p>
<p>営業時間: {cf_shop_open}〜{cf_shop_close}</p>
<p>{cf_shop_access}[nl2br]</p>
<!-- BEGIN cf_shop_note:veil --><p>{cf_shop_note}[nl2br]</p><!-- END cf_shop_note:veil -->
<!-- END_MODULE Entry_Field -->

注意

  • タブの入れ物の中にはタブだけ、タブはタブの入れ物の中にだけ置けます。置けない位置にはドラッグできません。

  • 箱を削除すると、中のフィールドは 1 つ上の階層に移ります(中のフィールドは削除されません)。

  • 箱に「権限・ロール別の表示」や「条件付き表示」を付けると、中のフィールドにも効きます。

  • フィールドセットそのものに、セクションやタブの見た目を選ぶ設定はありません。タブで切り替えたいときは「タブの入れ物」と「タブ」を使います。

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


この機能は 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 で受け取れます。

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

コンポーネント


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

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

コンポーネントは、いくつかのフィールドの組に名前を付け、ほかのフィールドセットから使い回す仕組みです。例えば「リンク(URL・リンクテキスト・新しいタブで開く)」をコンポーネントにすると、どの対象のどのフィールドセットにも同じ組を置けます。コンポーネントの中身を変えると、使っているすべての場所に反映されます。

コンポーネントを作る

管理画面の「フィールド定義」の「コンポーネント」タブで、コンポーネントを追加します(ラベル「リンク」、コード link)。コンポーネントに、次の 3 つのフィールドを追加します。

型

キー

ラベル

URL

url

URL

テキスト

label

リンクテキスト

チェックボックス(「複数選択できるようにする」をオフ)

blank

新しいタブで開く

コンポーネントの中のキーには cf_ のような接頭辞は要りません(使う側のキーが前に付きます)。

コンポーネントを使う

使う側は、対象のタブ(ここではエントリー)のフィールドセットで、「レイアウト」の「コンポーネント」を追加します。キー main_link・ラベル「メインのリンク」とし、「使うコンポーネント」で「リンク(link)」を選びます。同じように、キー sub_link・ラベル「サブのリンク」でもう 1 つ追加します。

定義画面のカードには「リンク(link)を展開: main_link_url, main_link_label, main_link_blank」のように、展開後のキーが表示されます。コンポーネントの一覧の「使用箇所」では、どの対象で何回使われているかを確かめられます。

テーマの JSON で書くときは、コンポーネントを admin/field-definitions/component.json に、使う側を各対象のファイルに書きます。

{
  "version": 1,
  "entityType": "component",
  "sets": [
    {
      "code": "link",
      "label": "リンク",
      "fields": [
        { "key": "url", "label": "URL", "type": "url", "validation": { "required": "none", "rules": [] } },
        { "key": "label", "label": "リンクテキスト", "type": "text" },
        { "key": "blank", "label": "新しいタブで開く", "type": "checkbox", "config": { "multiple": false } }
      ]
    }
  ]
}
{
  "version": 1,
  "entityType": "entry",
  "sets": [
    {
      "code": "cta",
      "label": "ボタン",
      "fields": [
        { "key": "main_link", "label": "メインのリンク", "type": "component", "config": { "component": "link" } },
        { "key": "sub_link", "label": "サブのリンク", "type": "component", "config": { "component": "link" } }
      ]
    }
  ]
}

編集画面での見え方

コンポーネントのフィールドは、ラベル(「メインのリンク」)を見出しにしたアコーディオンになり、その中にコンポーネントの中身(URL・リンクテキスト・新しいタブで開く)が並びます。

保存されるキー

コンポーネントの中のフィールドは、<フィールドのキー>_<中のキー> というキーで、使う側の対象(この例ではエントリー)のカスタムフィールドとして保存されます。

使う側のフィールド

保存されるキー

main_link

main_link_url・main_link_label・main_link_blank

sub_link

sub_link_url・sub_link_label・sub_link_blank

コンポーネントの中にフィールドグループがあるときは、器のキーも <フィールドのキー>_<器のキー> になります。

テンプレートの例

展開後のキーを、普通のカスタムフィールドとして書きます。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN main_link_url:veil -->
<a href="{main_link_url}" class="button-primary"<!-- BEGIN_IF [{main_link_blank}/eq/on] --> target="_blank" rel="noopener"<!-- END_IF -->>{main_link_label}</a>
<!-- END main_link_url:veil -->
<!-- BEGIN sub_link_url:veil -->
<a href="{sub_link_url}" class="button-secondary"<!-- BEGIN_IF [{sub_link_blank}/eq/on] --> target="_blank" rel="noopener"<!-- END_IF -->>{sub_link_label}</a>
<!-- END sub_link_url:veil -->
<!-- END_MODULE Entry_Field -->
{% set f = module('V2_Entry_Field').fields %}
{% if f.main_link_url.value %}
<a href="{{ f.main_link_url.value }}"{% if f.main_link_blank.value == 'on' %} target="_blank" rel="noopener"{% endif %}>{{ f.main_link_label.value }}</a>
{% endif %}

コンポーネントの中にフィールドグループがある例です。コンポーネント faq(中に器 items、その中に q と a)を、キー faq_sec で使った場合は、次のように書きます。

<!-- BEGIN_MODULE Entry_Field -->
<dl class="faq">
  <!-- BEGIN faq_sec_items:loop -->
  <dt>{faq_sec_q}</dt>
  <dd>{faq_sec_a}[nl2br]</dd>
  <!-- END faq_sec_items:loop -->
</dl>
<!-- END_MODULE Entry_Field -->

制約と注意

  • 展開後のキーが 64 文字を超えるとき、ほかのキーと重なるとき(大文字と小文字は区別しません)は保存できません。キーを短くするか、変えてください。

  • コンポーネントの中に、コンポーネントやブロックは置けません。

  • コンポーネントには、5 つの対象(エントリー・カテゴリー・ブログ・ユーザー・モジュール)のすべてで使える型だけを置けます。アーカイブ画像・アーカイブファイルは置けません。

  • コンポーネントの中のフィールドの設定(必須など)は、使う側では変えられません。

  • コンポーネントのフィールドは、フィールドグループの中にも置けます。そのときは、展開した結果がフィールドグループの規則を満たす必要があります。

  • 使われているコンポーネントは削除できません。コンポーネントを無効にすると、使っている場所の編集画面には何も出ません(保存済みの値は残ります)。

  • Twig で、コンポーネントの単位でまとめて読む書き方(f.main_link.url のような形)はありません。展開後のキーで読みます。

項目ごとにブロックを選ぶフィールドグループ


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

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

フィールドグループの設定「項目ごとにブロックを 1 つ選ぶ」をオンにすると、項目を追加するときにブロックを選び、その項目には選んだブロックの欄だけを出せます。「見出しと画像」「文章」「リンク」のように、形の違う入力を好きな順に並べたいときに使います。プロフェッショナルライセンス以上で使えます。

ブロックの作り方

このフィールドグループの直下には、次のどちらかだけを置けます。それぞれが 1 つのブロックになります。

ブロックの作り方

型

中のフィールドのキー

その場で定義する

「ブロック」(kind)。中に、そのブロックの項目に出すフィールドを置きます。

そのままのキー

コンポーネントを使う

「コンポーネント」のフィールド

<フィールドのキー>_<中のキー>

「ブロック」は、このフィールドグループの直下にだけ置けます。コンポーネントの中には置けません。

作る手順

「見出しと画像」「文章」の 2 つのブロックと、コンポーネント link(コンポーネント で作ったもの)を選べるようにする例です。

フィールドセットで「フィールドグループ」を追加し(キー blocks・ラベル「ブロック」)、高度な設定で「項目ごとにブロックを 1 つ選ぶ」にチェックします。器の中に、「ブロック」としてキー hero(見出しと画像。中にテキスト hero_catch とメディア画像 hero_image)とキー text(文章。中にテキストエリア text_body)を追加し、「コンポーネント」としてキー cta_link(使うコンポーネントは「リンク(link)」)を追加します。

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

{
  "version": 1,
  "entityType": "entry",
  "sets": [
    {
      "code": "contents",
      "label": "ページの内容",
      "fields": [
        { "key": "blocks", "label": "ブロック", "type": "group", "config": { "componentPerRow": true, "maxRows": 20 } },
        { "key": "hero", "label": "見出しと画像", "type": "kind", "parentKey": "blocks" },
        { "key": "hero_catch", "label": "キャッチコピー", "type": "text", "parentKey": "hero" },
        { "key": "hero_image", "label": "画像", "type": "media-image", "parentKey": "hero" },
        { "key": "text", "label": "文章", "type": "kind", "parentKey": "blocks" },
        { "key": "text_body", "label": "本文", "type": "textarea", "parentKey": "text" },
        { "key": "cta_link", "label": "リンク", "type": "component", "parentKey": "blocks", "config": { "component": "link" } }
      ]
    }
  ]
}

編集画面での見え方

  • 項目を足すときにブロックを選び、項目には、選んだブロックの欄だけが出ます。

  • 項目の見出しは「項目 1(見出しと画像)」のように、選んだブロックの名前付きで出ます。

  • ブロックが選ばれていない項目は、空の項目として扱われます。「ブロックを選ぶ」でブロックを選べます。

  • 別のブロックに選び直すと、前のブロックの欄の値は保存したときに消えます(選び直す前に確認が出ます)。

保存されるキー

普通のフィールドグループと同じ形で保存し、項目ごとに選んだブロックを <器のキー>_kind に保存します。

キー

保存される値(「見出しと画像」「リンク」「見出しと画像」の 3 項目の例)

blocks_kind

hero、cta_link、hero

hero_catch

はじめに、(空)、おわりに

hero_image・hero_image@media

メディアの ID、(空)、メディアの ID

text_body

(空)、(空)、(空)

cta_link_url・cta_link_label・cta_link_blank

(空)、値、(空)

  • <器のキー>_kind の値は、選んだブロックのキー(型「ブロック」のキー、またはコンポーネントのフィールドのキー)です。

  • 保存の前に、選んでいないブロックの欄は空になります。

  • <器のキー>_kind のキーが 64 文字を超えるとき、ほかのキーと重なるときは、この設定は効かず、普通のフィールドグループとして扱われます。

テンプレートの例

ループの中で {blocks_kind} を見て、ブロックごとに出し分けます。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN blocks:loop -->
<!-- BEGIN_IF [{blocks_kind}/eq/hero] -->
<section class="block-hero">
  <h2>{hero_catch}</h2>
  <img src="%{MEDIA_ARCHIVES_DIR}{hero_image@path}" alt="{hero_image@alt}">
</section>
<!-- ELSE_IF [{blocks_kind}/eq/text] -->
<div class="block-text">{text_body}[nl2br]</div>
<!-- ELSE_IF [{blocks_kind}/eq/cta_link] -->
<p class="block-link"><a href="{cta_link_url}">{cta_link_label}</a></p>
<!-- END_IF -->
<!-- END blocks:loop -->
<!-- END_MODULE Entry_Field -->
{% set f = module('V2_Entry_Field').fields %}
{% for row in f.blocks %}
  {% if row.blocks_kind.value == 'hero' %}
    <section class="block-hero"><h2>{{ row.hero_catch.value }}</h2></section>
  {% elseif row.blocks_kind.value == 'text' %}
    <div class="block-text">{{ row.text_body.value|nl2br }}</div>
  {% elseif row.blocks_kind.value == 'cta_link' %}
    <p class="block-link"><a href="{{ row.cta_link_url.value }}">{{ row.cta_link_label.value }}</a></p>
  {% endif %}
{% endfor %}

注意

  • 直下に「ブロック」があるあいだは、「項目ごとにブロックを 1 つ選ぶ」を外せません。先にブロックを削除するか、ほかのフィールドグループへ移します。

  • 値のあるフィールドグループで後から有効にすると、既存の項目はブロックが空になり、ブロックを選ぶまで項目として数えません(値は残ります)。

  • 行数・必須・重複の判定は、選んだブロックの欄だけで行います。

  • スタンダードライセンスでは、この設定のフィールドグループは読み取り専用になります。保存済みの値は消えません。外して保存すると、スタンダードでは付け直せません。

テンプレートでの出力(基本の型)


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

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

値は、フィールド定義のキーで、従来のカスタムフィールドと同じテーブルに保存されます。そのため、従来のカスタムフィールドと同じモジュール・同じ変数で出せます。メディア・参照・地図などは「テンプレートでの出力(メディア・参照・地図・アップロード)」を参照してください。

値を出すモジュールと書く場所

対象

標準のテンプレート

Twig

エントリー

エントリーの詳細ページの Entry_Field モジュールの中。または Entry_Body・Entry_Summary などの entry:loop の中(エントリーのカスタムフィールドの表示が有効なとき)

module('V2_Entry_Field').fields(URL のエントリー)

カテゴリー

Category_Field モジュールの中

module('V2_Category_Field').fields(URL のカテゴリー)

ブログ

Blog_Field モジュールの中

module('V2_Blog_Field').fields

ユーザー

User_Field モジュールの中

module('V2_User_Field').fields(URL のユーザー)

モジュール

そのモジュール ID のモジュールの <!-- BEGIN moduleField --> の中(モジュール ID で「カスタムフィールドを表示」にチェックが要ります)

V2 モジュールの戻り値の moduleFields

このページの例は、エントリーの詳細ページで Entry_Field を使って書いています。ほかのモジュールでも、変数の書き方は同じです。

<!-- BEGIN_MODULE Entry_Summary id="topics" -->
<!-- BEGIN moduleField --><h2>{cf_section_title}</h2><!-- END moduleField -->
<!-- BEGIN unit:loop -->
<!-- BEGIN entry:loop -->
<article>
  <h3><a href="{url}">{title}</a></h3>
  <p>{cf_lead}</p>
</article>
<!-- END entry:loop -->
<!-- END unit:loop -->
<!-- END_MODULE Entry_Summary -->

上の例の {cf_section_title} はモジュール ID「topics」に定義したフィールド、{cf_lead} はエントリーに定義したフィールドです。Entry_Summary でエントリーのカスタムフィールドを出すには、モジュール ID の設定でエントリーのカスタムフィールドの表示が有効になっている必要があります(既定で有効です)。

標準のテンプレートの基本

書き方

意味

{キー}

値を出します。HTML の特殊文字はエスケープされます。

<!-- BEGIN キー:veil -->…<!-- END キー:veil -->

値があるときだけ中を出します。

<!-- BEGIN キー:loop -->{キー}<!-- END キー:loop -->

複数の値を 1 つずつ出します。

{キー[0]}・{キー[1]}

複数の値のうち、何番目かを出します(0 から数えます)。

{キー}[nl2br]

改行を <br> にします。

{キー}[date('Y年n月j日')]

日付の形を変えます。

{キー}[number_format(2)]

3 桁区切り・小数部の桁数をそろえます(1500.5 は 1,500.50)。桁数を書かない [number_format] は小数点以下を四捨五入します(1500.5 は 1,501)。

{キー}[raw]

エスケープせずに出します(ブロックエディターなど HTML の値だけに使います)。

<!-- BEGIN_IF [{キー}/eq/値] -->…<!-- END_IF -->

値で出し分けます。

セレクトボックス・チェックボックス・ラジオボタンは、選んだ選択肢の「値」を保存します。表示名を出すときは、BEGIN_IF で値から読み替えます。

型ごとの例

次のフィールドを定義したときの例です。

キー

型

設定

cf_lead

テキスト

—

cf_body

テキストエリア

—

cf_type

セレクトボックス

選択肢 seminar(セミナー)・workshop(ワークショップ)

cf_features

チェックボックス

複数選択。選択肢 parking(駐車場あり)・wifi(Wi-Fi あり)

cf_reserved

チェックボックス

「複数選択できるようにする」をオフ(単一の on/off)

cf_date

日付

表示フォーマットは既定(Y-m-d)

cf_open_time

時刻

既定(H:i)

cf_deadline

日時

既定(Y-m-d H:i)

cf_price

数値

—

cf_tel・cf_email・cf_url

電話番号・メールアドレス・URL

—

cf_note

ブロックエディター

—

<!-- BEGIN_MODULE Entry_Field -->
<!-- テキスト -->
<!-- BEGIN cf_lead:veil --><p class="lead">{cf_lead}</p><!-- END cf_lead:veil -->

<!-- テキストエリア(改行を <br> にする) -->
<!-- BEGIN cf_body:veil --><p>{cf_body}[nl2br]</p><!-- END cf_body:veil -->

<!-- セレクトボックス(単一)・ラジオボタン: 値で表示名に読み替える -->
<p>種類:
<!-- BEGIN_IF [{cf_type}/eq/seminar] -->セミナー
<!-- ELSE_IF [{cf_type}/eq/workshop] -->ワークショップ
<!-- END_IF -->
</p>

<!-- チェックボックス(複数選択)・セレクトボックス(複数選択) -->
<!-- BEGIN cf_features:veil -->
<ul class="features">
  <!-- BEGIN cf_features:loop -->
  <li><!-- BEGIN_IF [{cf_features}/eq/parking] -->駐車場あり<!-- ELSE_IF [{cf_features}/eq/wifi] -->Wi-Fi あり<!-- ELSE -->{cf_features}<!-- END_IF --></li>
  <!-- END cf_features:loop -->
</ul>
<!-- END cf_features:veil -->

<!-- チェックボックス(単一の on/off。チェック時の値は既定の on) -->
<!-- BEGIN_IF [{cf_reserved}/eq/on] --><p>要予約</p><!-- END_IF -->

<!-- 日付・時刻・日時 -->
<p>開催日: {cf_date}[date('Y年n月j日')]</p>
<p>開場: {cf_open_time}</p>
<p>受付終了: {cf_deadline}[date('Y/m/d H:i')]</p>

<!-- 数値 -->
<p>料金: {cf_price}[number_format]円</p>

<!-- 電話番号・メールアドレス・URL -->
<p><a href="tel:{cf_tel}">{cf_tel}</a></p>
<p><a href="mailto:{cf_email}">{cf_email}</a></p>
<!-- BEGIN cf_url:veil --><p><a href="{cf_url}">{cf_url}</a></p><!-- END cf_url:veil -->

<!-- ブロックエディター(HTML をそのまま出す) -->
<!-- BEGIN cf_note:veil --><div class="note">{cf_note}[raw]</div><!-- END cf_note:veil -->
<!-- END_MODULE Entry_Field -->

保存される値の形

型

保存される値

例

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

入力した文字列(入力の変換を設定していれば変換後)

東京国際フォーラム

セレクトボックス(単一)・ラジオボタン

選んだ選択肢の値

seminar

チェックボックス・セレクトボックス(複数選択)

選んだ選択肢の値を、選択肢の並び順に複数

parking、wifi

チェックボックス(単一の on/off)

チェック時の値(既定 on)。外すと空

on

日付・時刻・日時

表示フォーマットの形の文字列

2026-11-10、09:30、2026-11-10 09:30

数値

半角の数値

1500、1.5

隠し値(hidden)

値

v1

ブロックエディター

HTML

<p>…</p>

Twig で書く

Twig を使うテーマでは、フィールドを取り出すモジュールの fields から読みます。

  • 1 つの値は f.キー.value、すべての値は f.キー.array で読みます。

  • 数字だけの値は数値に、true / false は真偽値に、空の値は null になります。先頭が 0 の 2 文字以上の値(電話番号など)は文字列のままです。

  • ブロックエディターの値は |raw で出します。ほかの値には |raw を使わないでください。

{% set f = module('V2_Entry_Field').fields %}

{% if f.cf_lead.value %}<p class="lead">{{ f.cf_lead.value }}</p>{% endif %}
{% if f.cf_body.value %}<p>{{ f.cf_body.value|nl2br }}</p>{% endif %}

{% set typeLabels = {'seminar': 'セミナー', 'workshop': 'ワークショップ'} %}
<p>種類: {{ typeLabels[f.cf_type.value] ?? '' }}</p>

{% set featureLabels = {'parking': '駐車場あり', 'wifi': 'Wi-Fi あり'} %}
{% if f.cf_features.array %}
<ul class="features">
  {% for feature in f.cf_features.array %}
  <li>{{ featureLabels[feature] ?? feature }}</li>
  {% endfor %}
</ul>
{% endif %}

{% if f.cf_reserved.value == 'on' %}<p>要予約</p>{% endif %}

<p>開催日: {{ f.cf_date.value|date('Y年n月j日') }}</p>
<p>料金: {{ f.cf_price.value|number_format }}円</p>
<p><a href="tel:{{ f.cf_tel.value }}">{{ f.cf_tel.value }}</a></p>

{% if f.cf_note.value %}<div class="note">{{ f.cf_note.value|raw }}</div>{% endif %}

つまずきやすい点

  • 値が出ないときは、まずモジュールの種類と書く場所を確かめます。エントリーのカスタムフィールドは、entry:loop の外に書いても出ません。

  • 表示名が出ない(値が出る)のは仕様です。選択肢は値を保存します。

  • 日付の表示フォーマットを変えた場合、[date(...)] で読めない形(例: Y年m月d日)にすると、並べ替えや整形に使いにくくなります。保存の形は既定の Y-m-d を勧めます。

  • ほかのよくある問題は「よくあるつまずきと注意点」を参照してください。

テンプレートでの出力(メディア・参照・地図・アップロード)


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

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

このページの型は、キー@path のような派生キーで値を出します。派生キーの多くは保存されず、表示のたびにメディアや参照先から作られます。書く場所(モジュール)は「テンプレートでの出力(基本の型)」と同じです。

メディア画像

キー と キー@media にメディアの ID を保存します。表示のときに、次の派生キーが付きます。

派生キー

内容

@path

画像のパス(001/202611/xxx.png?v=… のような相対パス)。%{MEDIA_ARCHIVES_DIR} を前に付けて使います

@alt・@caption・@link・@text

メディアの代替テキスト・キャプション・リンク・説明

@width・@height・@ratio・@imageSize

画像の幅・高さ・縦横比・大きさ

@name・@extension・@fileSize・@type

ファイル名・拡張子・バイト数・種類

@focalX・@focalY

焦点の位置

@thumbnail

サムネイル(/media/… のようにルートから始まる URL です。%{MEDIA_ARCHIVES_DIR} は付けません)

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_main_image:veil -->
<figure>
  <img src="%{MEDIA_ARCHIVES_DIR}{cf_main_image@path}" alt="{cf_main_image@alt}" width="{cf_main_image@width}" height="{cf_main_image@height}">
  <!-- BEGIN cf_main_image@caption:veil --><figcaption>{cf_main_image@caption}</figcaption><!-- END cf_main_image@caption:veil -->
</figure>
<!-- END cf_main_image:veil -->
<!-- END_MODULE Entry_Field -->
{% set f = module('V2_Entry_Field').fields %}
{% set image = f.cf_main_image.value %}
{% if image and image.path %}
<figure>
  <img src="{{ image.path }}" alt="{{ image.alt }}" width="{{ image.width }}" height="{{ image.height }}">
  {% if image.caption %}<figcaption>{{ image.caption }}</figcaption>{% endif %}
</figure>
{% endif %}

メディアファイル

保存の形はメディア画像と同じです。@path はファイルのダウンロード用の URL で、/media-download/… のようにルートから始まります。前には何も付けません(%{MEDIA_ARCHIVES_DIR} を付けると URL が壊れます)。メディア画像の @path とは前に付けるものが違う点に注意してください。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_pdf:veil -->
<p><a href="{cf_pdf@path}">{cf_pdf@name}</a>({cf_pdf@extension})</p>
<!-- END cf_pdf:veil -->
<!-- END_MODULE Entry_Field -->
{% set pdf = module('V2_Entry_Field').fields.cf_pdf.value %}
{% if pdf and pdf.path %}<p><a href="{{ pdf.path }}">{{ pdf.name }}</a>({{ pdf.extension }})</p>{% endif %}

メディアギャラリー

キー と キー@media に、メディアの ID を複数保存します。標準のテンプレートでは、ループの名前に派生キーまで書きます(キー:loop ではメディアの ID だけが出ます)。ループの中で {cf_gallery@path} のようにループに書いた派生キーは出ますが、それ以外の派生キー({cf_gallery@alt} など)は空になります。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_gallery:veil -->
<ul class="gallery">
  <!-- BEGIN cf_gallery@path:loop -->
  <li><img src="%{MEDIA_ARCHIVES_DIR}{cf_gallery@path}" alt=""></li>
  <!-- END cf_gallery@path:loop -->
</ul>
<!-- END cf_gallery:veil -->
<!-- END_MODULE Entry_Field -->

代替テキストを出したいときは、次のどちらかにします。

  • 添字を付けて、1 枚ずつ書く。{cf_gallery@alt[1]} のように [ ] に 0 から数えた番号を書くと、その番号の画像の代替テキストが出ます([0] が 1 枚目、[1] が 2 枚目)。枚数が決まっているときに向いています。

  • Twig で書く(下の例)。ループの中で image.path・image.alt などをすべて使えます。枚数が決まっていないときはこちらを使います。

<!-- 1 枚目と 2 枚目を、代替テキスト付きで出す(添字は 0 始まり) -->
<img src="%{MEDIA_ARCHIVES_DIR}{cf_gallery@path[0]}" alt="{cf_gallery@alt[0]}">
<img src="%{MEDIA_ARCHIVES_DIR}{cf_gallery@path[1]}" alt="{cf_gallery@alt[1]}">
{% set f = module('V2_Entry_Field').fields %}
{% if f.cf_gallery.array %}
<ul class="gallery">
  {% for image in f.cf_gallery.array %}
  <li><img src="{{ image.path }}" alt="{{ image.alt }}"></li>
  {% endfor %}
</ul>
{% endif %}

メディア画像(1 枚)をフィールドグループに入れて作る方法もあります(フィールドグループ(繰り返し))。

参照(1 件)

キー と キー@entry(カテゴリーは @category、ユーザーは @user)に参照先の ID を保存します。公開側では、参照先の値を次の派生キーで出せます。値は表示のたびに参照先から読むため、参照先を更新すると表示も変わります。

参照先

派生キー

エントリー

@title(タイトル)・@url(リンク先。エントリーのリンク先の設定に従います)・@permalink(エントリー自身の URL)・@code・@datetime・@categoryName・@eid・@bid・@cid・@uid

カテゴリー

@name・@code・@url・@cid・@bid

ユーザー

@name・@code・@icon(アイコン画像の URL)・@uid

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_related@title:veil -->
<p>関連: <a href="{cf_related@url}">{cf_related@title}</a>({cf_related@datetime}[date('Y/m/d')])</p>
<!-- END cf_related@title:veil -->

<!-- BEGIN cf_area@name:veil -->
<p>エリア: <a href="{cf_area@url}">{cf_area@name}</a></p>
<!-- END cf_area@name:veil -->

<!-- BEGIN cf_writer@name:veil -->
<p class="writer"><img src="{cf_writer@icon}" alt="">{cf_writer@name}</p>
<!-- END cf_writer@name:veil -->
<!-- END_MODULE Entry_Field -->
{% set f = module('V2_Entry_Field').fields %}
{% set related = f.cf_related.value %}
{% if related and related.title %}
<p>関連: <a href="{{ related.url }}">{{ related.title }}</a></p>
{% endif %}
  • 閲覧している人から見えない参照先(下書き・非公開・公開期間外など)と、削除された参照先は出しません。

  • Twig では、参照先のエントリー・カテゴリーのカスタムフィールドも f.キー.value.fields.参照先のキー.value で読めます(1 段だけ)。ユーザーのカスタムフィールドは、定義の設定「ユーザーのカスタムフィールドを公開側に出す」をオンにしたときだけ読めます。

参照(複数)

標準のテンプレートでは、ループの名前に派生キーまで書きます。ループの中で値が出るのは、ループに書いた派生キーだけです(cf_related_list@title:loop の中の {cf_related_list@url} は空になります)。タイトルとリンクを並べて出すときは、Twig を使うか、「参照(1 件)」をフィールドグループに入れて作ってください。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_related_list@title:veil -->
<ul>
  <!-- BEGIN cf_related_list@title:loop -->
  <li>{cf_related_list@title}</li>
  <!-- END cf_related_list@title:loop -->
</ul>
<!-- END cf_related_list@title:veil -->
<!-- END_MODULE Entry_Field -->

上の例はタイトルだけを出します。リンクも付けるときは、次の Twig か、下のフィールドグループの例を使います。

{% set f = module('V2_Entry_Field').fields %}
{% if f.cf_related_list.array %}
<ul>
  {% for entry in f.cf_related_list.array %}
  <li><a href="{{ entry.url }}">{{ entry.title }}</a></li>
  {% endfor %}
</ul>
{% endif %}

参照(1 件)をフィールドグループ related_group(メンバー related_item)に入れた場合は、標準のテンプレートでも次のように書けます(フィールドグループの出力は、ステージングなどの環境でも確かめてください)。

<ul>
<!-- BEGIN related_group:loop -->
  <li><a href="{related_item@url}">{related_item@title}</a></li>
<!-- END related_group:loop -->
</ul>

地図

キー に「緯度,経度」を、キー@lat・キー@lng・キー@zoom に緯度・経度・ズームを保存します。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_map@lat:veil -->
<p><a href="https://www.google.com/maps?q={cf_map@lat},{cf_map@lng}" target="_blank" rel="noopener">地図を開く</a></p>
<div class="map" data-lat="{cf_map@lat}" data-lng="{cf_map@lng}" data-zoom="{cf_map@zoom}"></div>
<!-- END cf_map@lat:veil -->
<!-- END_MODULE Entry_Field -->
{% set map = module('V2_Entry_Field').fields.cf_map.value %}
{% if map and map.lat %}
<div class="map" data-lat="{{ map.lat }}" data-lng="{{ map.lng }}" data-zoom="{{ map.zoom }}"></div>
{% endif %}

地図を描くスクリプトは、テーマで用意します。

アーカイブ画像・アーカイブファイル(ユーザー)

ユーザーの定義でだけ使える型です。従来の画像・ファイルのカスタムフィールドと同じ派生キーで保存します。

型

派生キー

アーカイブ画像

@path・@x・@y・@alt・@fileSize、大きい画像・小さい画像・正方形の画像は @largePath・@tinyPath・@squarePath など(X・Y・Alt・FileSize も同じ形)

アーカイブファイル

@path・@baseName・@fileSize・@originalName・@downloadName

<!-- BEGIN_MODULE User_Field -->
<!-- BEGIN cf_photo@path:veil -->
<img src="%{ARCHIVES_DIR}{cf_photo@path}" width="{cf_photo@x}" height="{cf_photo@y}" alt="{cf_photo@alt}">
<!-- END cf_photo@path:veil -->
<!-- BEGIN cf_profile_pdf@path:veil -->
<a href="%{ARCHIVES_DIR}{cf_profile_pdf@path}">{cf_profile_pdf@originalName}</a>
<!-- END cf_profile_pdf@path:veil -->
<!-- END_MODULE User_Field -->
{% set uf = module('V2_User_Field').fields %}
{% if uf.cf_photo.value and uf.cf_photo.value.path %}
<img src="{{ uf.cf_photo.value.path }}" alt="{{ uf.cf_photo.value.alt }}">
{% endif %}

テーマでフィールド定義を宣言する


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

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

テーマにフィールド定義の JSON ファイルを置くと、そのテーマを使うブログで、管理画面で作った定義と同じように編集画面に出ます。テンプレートと一緒に定義もファイルで持ち運べるため、案件をまたいでフィールドを使い回せます。

置き場所と読み込まれる条件

対象

ファイル

エントリー

themes/<テーマ>/admin/field-definitions/entry.json

カテゴリー

themes/<テーマ>/admin/field-definitions/category.json

ブログ

themes/<テーマ>/admin/field-definitions/blog.json

ユーザー

themes/<テーマ>/admin/field-definitions/user.json

モジュール

themes/<テーマ>/admin/field-definitions/module.json

コンポーネント

themes/<テーマ>/admin/field-definitions/component.json

  • テーマの宣言が効くのは、そのテーマを使っているブログです。

  • 親テーマ(テーマ名@親テーマ名)がある場合は、親テーマのファイルも読みます。同じコードのフィールドセットは、子テーマのものがフィールドセットごと置き換わります。

  • ファイルを書き換えると、次の表示から反映されます。

  • ファイルが 1MB を超える、JSON として読めない、version や entityType が違う場合は、ファイルごと読みません。形の誤ったフィールドセット・フィールドはその部分だけ読まず、知らないキーは無視します。いずれも監査ログに警告を残します。

完全な例

エントリーの「イベント情報」を宣言した entry.json です。そのまま読み込めます。表示条件の event はカテゴリーのコードです。そのブログに「event」カテゴリーが無いと、条件を読み替えられないため、このフィールドセットは無効で読み込まれます。

{
  "version": 1,
  "entityType": "entry",
  "sets": [
    {
      "code": "event",
      "label": "イベント情報",
      "description": "イベントカテゴリーのエントリーに出します。",
      "status": "open",
      "layout": { "placement": "foot" },
      "conditions": {
        "or": [
          { "and": [ { "subject": "category", "operator": "eq", "value": "event", "axis": "descendant-or-self" } ] }
        ]
      },
      "fields": [
        { "key": "cf_event_box", "label": "開催情報", "type": "accordion" },
        {
          "key": "cf_event_date",
          "label": "開催日",
          "labels": { "en": "Date" },
          "type": "date",
          "parentKey": "cf_event_box",
          "config": { "width": 50 },
          "validation": { "required": "publish", "rules": [] }
        },
        {
          "key": "cf_event_place",
          "label": "会場",
          "type": "text",
          "parentKey": "cf_event_box",
          "config": { "width": 50, "placeholder": "例: 東京国際フォーラム" },
          "validation": { "required": "none", "rules": [ { "method": "maxlength", "arg": "100", "message": "100 文字以内で入力してください。" } ] }
        },
        {
          "key": "cf_event_type",
          "label": "種類",
          "type": "select",
          "config": {
            "options": [
              { "value": "seminar", "label": "セミナー" },
              { "value": "workshop", "label": "ワークショップ" }
            ],
            "emptyLabel": "選択してください"
          }
        },
        {
          "key": "cf_event_capacity",
          "label": "定員",
          "type": "number",
          "description": "セミナーのときだけ入力します。",
          "config": { "suffix": "名" },
          "conditions": {
            "or": [ { "and": [ { "field": "cf_event_type", "operator": "eq", "value": "seminar" } ] } ]
          },
          "validation": { "required": "none", "rules": [ { "method": "min", "arg": "1" } ] }
        },
        {
          "key": "cf_event_memo",
          "label": "社内メモ",
          "type": "textarea",
          "search": false,
          "config": { "visibility": { "default": "hidden", "byAuth": { "editor": "editable" } } }
        }
      ]
    }
  ]
}

この例では、次のことを宣言しています。

  • 「イベント情報」を本文の下(foot)に出し、「event」カテゴリーとその配下のエントリーだけに出します。

  • 「開催日」「会場」をアコーディオン「開催情報」の中に、50% の幅で横に並べます。「開催日」は公開時に必須です。

  • 「種類」がセミナーのときだけ「定員」を出します。

  • 「社内メモ」は、管理者と編集者だけに出し、ほかの人には出しません。キーワード検索の対象にしません。

トップレベルとフィールドセットのキー

キー

必須

型

既定値

内容

version

必須

数値

—

1 を書きます。

entityType

必須

文字列

—

ファイル名と同じ対象(entry など)。

sets

必須

配列

—

フィールドセットの配列。

フィールドセットのキー

必須

型

既定値

内容

code

必須

文字列

—

半角英数字とアンダースコアの 64 文字以内。

label

必須

文字列

—

ラベル。

description

文字列

""

説明。

status

文字列

"open"

"open"(有効)か "close"(無効)。

layout

オブジェクト

null(標準の位置)

{"placement": "場所の名前"}。場所の名前は main・foot・side など。

conditions

オブジェクト

null(常に出す)

表示条件(後述)。

fields

配列

[]

フィールドの配列。

scope

文字列

—

"local" か "global"。テーマの宣言では使われません(後述)。

フィールドのキー

キー

必須

型

既定値

内容

key

必須

文字列

—

テンプレートのキー。半角英字かアンダースコアで始まる、半角英数字とアンダースコアの 64 文字以内。

label

必須

文字列

—

ラベル。

type

必須

文字列

—

型のキー(text・select・group など)。

labels

オブジェクト

なし

ロケールごとのラベル({"en": "Date"})。管理画面の言語に合わせて出します。管理画面では編集できません。

description

文字列

""

説明。

status

文字列

"open"

"open" か "close"。

parentKey

文字列

null

入れる箱・フィールドグループ・ブロックのキー。

search

真偽値

true

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

config

オブジェクト

{}

型ごとの設定と、共通の設定(後述)。

validation

オブジェクト

任意・チェックなし

required("none"・"save"・"publish")と rules(method・arg・message の配列)。arg は文字列で書きます。

conditions

オブジェクト

null

条件付き表示(後述)。

sort

整数

なし

テーマの宣言だけで使えます。管理画面で作った定義との並び順を数値で決めます。

共通の設定の config のキーは次のとおりです。型ごとの設定のキーは「入力の型の設定(文字・選択・日付・数値)」「メディア・参照・地図・アップロード・ブロックエディターの型の設定」「レイアウトの型(見出し・メッセージ・行・タブ・アコーディオン)」「フィールドグループ(繰り返し)」の表を参照してください。

config のキー

型

内容

例

width

整数

列幅(25・33・50・66・75・100)。ほかの値は 100 になります。

50

defaultValue

文字列

初期値。

"seminar"

tooltip

文字列

補足(ツールチップ)。

"半角で入力します"

inputWidth

文字列

入力欄の長さ(mini・small・medium・large・full)。

"small"

clearOnHide

真偽値

条件付き表示で隠れているときは値を保存しない。

true

visibility

オブジェクト

権限・ロール別の表示。default(指定のないユーザー)、byAuth(editor・contributor・subscriber)、byRole(ロール名)に editable・readonly・hidden を書きます。

{"default": "readonly"}

条件と参照の書き方

表示条件・条件付き表示は、どちらも {"or": [ {"and": [ 条件, … ]}, … ]} の形で書きます。and の中をすべて満たすか、or のどれかの組を満たすときに出します。

条件のキー

内容

subject

表示条件で使う項目の名前(category・blog など。一覧は フィールドセットの作成と設定)。フィールドセットの conditions で使います。

field

条件付き表示で比べるフィールドのキー。フィールドの conditions で使います。

operator

eq・neq・in・contains・empty・notEmpty・gt・lt・matches。

value

比べる値。in では配列にします。empty・notEmpty では書きません。

axis

"self"(そのもの)か "descendant-or-self"(それと配下すべて)。カテゴリー・ブログなど階層のある項目だけに書けます。

カテゴリー・ブログ・ユーザー・ロールは、ID ではなく次の表記で書きます。読み込むときに、そのブログの ID に読み替えます。

参照

表記

例

カテゴリー

ルートからのコードのパス

news、news/press

ブログ

先頭を / にしたコードのパス

/(ルートブログ)、/news

ユーザー

ブログのパス:ユーザーコード

/news:taro

ロール

ロール名

編集担当

参照型の選択範囲(scopeBlogId・scopeCategoryId・scopeParentCategoryId)も同じ表記で書きます。読み替えられない参照があると、その条件の組や設定を外し、フィールドセット・フィールドを無効(close)にして読み込みます。入力欄が意図せず広く出ないようにするためです。

テーマ由来の定義の扱い

  • テーマで宣言した定義は、定義画面で「テーマ」の印付きで並び、編集できません。定義元のファイルのパスも表示されます。

  • 管理画面で同じキーの定義を作ると、管理画面の定義が優先されます。同じコードのフィールドセットは 1 つにまとめ、フィールドセットの設定(ラベル・有効・表示する場所・表示条件)は管理画面のものを使います。

  • このブログでだけ使いたくない定義は、カードの「「(ラベル)」をこのブログでは使わない」で止められます。戻すときは「「(ラベル)」をこのブログで使う」を押します。テーマのファイルは書き換えません。

  • 並び順は、テーマだけのフィールドセット(書いた順)、管理画面で作ったフィールドセットの順です。フィールドは、テーマ由来(書いた順)の後に管理画面の定義が並びます。sort を書くと、管理画面の定義と数値で並びます。

子孫のブログへの継承

管理画面でフィールドセットの「子孫のブログにも継承する」をオンにすると、子孫のブログの編集画面にも出ます。

  • 継承した定義は、子孫のブログでは「親ブログ」の印付きで並び、編集できません。フィールドごとに「使わない」にできます。

  • 同じキーが複数の祖先にあるときは、近い祖先の定義を使います。

  • 有効なフィールドセットの、有効な定義だけを継承します。

  • 優先順位は、そのブログで作った定義 → テーマ由来の定義 → 継承した定義の順です。

テーマの宣言は継承しません

継承するのは、管理画面で作ったフィールドセットだけです。テーマの JSON に "scope": "global" を書いても、子孫のブログには継承されません。子孫のブログでも使うときは、子孫のブログのテーマにも同じ宣言を置きます。

宣言を作る手順

手で書くより、管理画面で作ってエクスポートするほうが確実です。

  • 検証環境の管理画面でフィールドセットとフィールドを作り、編集画面で動きを確かめます。

  • 定義画面の一覧からフィールドセットをエクスポートします。ダウンロードしたファイル(field-definitions-<対象>.json など)の名前を <対象>.json(例: entry.json)に変え、themes/<テーマ>/admin/field-definitions/ に置きます。複数のフィールドセットを 1 つのファイルにまとめるときは、sets の配列に並べます。

  • 別のブログ(またはサイト)でそのテーマを使い、編集画面に出ることを確かめます。

  • 検証に使ったブログの、管理画面で作った定義は削除します(同じキーの定義が残ると、管理画面の定義が優先されます)。

手で書き換えたときは、監査ログに定義の読み込みの警告が出ていないかも確かめてください。

テーマでパターン・独自の型・表示する場所を足す


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

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

足すもの

置き場所

フィールドパターン

themes/<テーマ>/admin/field-definitions/patterns/<名前>.json

独自のフィールド型

themes/<テーマ>/admin/field-types/<ディレクトリ>/field-type.json と入力欄のテンプレート

表示する場所

themes/<テーマ>/admin/field-definitions/placements.json と、編集画面のテンプレートの差し込み口

フィールドパターン

パターンは、よく使うフィールドの組です。型を選ぶ画面の「パターン」に並び、開いているフィールドセットの末尾にコピーして使います。

{
  "version": 1,
  "name": "住所",
  "description": "郵便番号・都道府県・住所の入力欄",
  "entityTypes": ["entry", "category"],
  "categories": ["address"],
  "wrapper": { "type": "accordion", "key": "cf_address_box", "label": "住所" },
  "fields": [
    { "key": "cf_address_row", "label": "郵便番号と都道府県", "type": "row" },
    { "key": "cf_zip", "label": "郵便番号", "type": "text", "parentKey": "cf_address_row",
      "validation": { "required": "none", "rules": [ { "method": "regex", "arg": "^[0-9]{3}-?[0-9]{4}$" } ] } },
    { "key": "cf_pref", "label": "都道府県", "type": "text", "parentKey": "cf_address_row" },
    { "key": "cf_address", "label": "住所", "type": "textarea", "config": { "rows": 2 } }
  ]
}

キー

必須

型

既定値

内容

version

必須

数値

—

1

fields

必須

配列

—

フィールドの配列。書き方はフィールド定義と同じです(テーマでフィールド定義を宣言する)。

name

文字列

ファイル名

「パターン」に出す名前。

description

文字列

空

説明。

entityTypes

配列

すべての対象

使える対象。

categories

配列

なし

分類。

wrapper

オブジェクト

なし

「まとめ方」でアコーディオン・見出しを選んだときの箱。type(accordion か heading)・key・label。

  • ファイル名は、英小文字・数字で始まり、英小文字・数字・ハイフン・アンダースコアの 64 文字以内にします。

  • 並びは、テーマのパターン、プラグインのパターン、標準のパターン(「SEO」「SEO・OGP 画像」)の順です。

  • 追加するとき、同じキーの定義がすでにあるフィールドは追加しません。箱・見出しのキーが重なるときは、末尾に _2 などを付けて追加します。

  • 追加後はパターンとのつながりは残りません。パターンのファイルを変えても、追加済みのフィールドは変わりません。

  • 中身の誤りは、パターンを追加するときにエラーになります。

独自のフィールド型

PHP を書かずに、テーマに宣言ファイルと入力欄のテンプレートを置いて型を足せます。例として、色を選ぶ型を作ります。

themes/<テーマ>/admin/field-types/color/
├── field-type.json
└── input.twig
{
  "key": "mytheme.color",
  "label": "色",
  "icon": "palette",
  "template": "input.twig",
  "configFields": [
    { "key": "palette", "label": "候補(カンマ区切り)", "type": "text", "default": "#000000,#ffffff" }
  ],
  "validators": ["regex"]
}

キー

必須

型

既定値

内容

template

必須

文字列

—

同じディレクトリにある入力欄のテンプレートのファイル名。.twig なら Twig、それ以外は標準のテンプレートとして描きます。

key

文字列

ディレクトリ名

型のキー(64 文字以内)。vendor.name の形にすると、ほかの型とぶつかりにくくなります。コアの型のキーは使えません。

label

文字列

キー

型を選ぶ画面の名前。

icon

文字列

空

アイコン名。

configFields

配列

なし

型ごとの設定の欄。各項目は key(必須)・label・type(text・textarea・select・checkbox・number など。ほかはテキスト)・description・default。

validators

配列

なし

入力チェックで選べる項目のメソッド名。必須・パスワードチェック・ファイルサイズ・入力の変換・重複禁止(メールアドレス)は書いても選べません。

入力欄のテンプレート(input.twig)です。

{% set palette = (definition.config.palette ?? '#000000')|split(',') %}
{% for color in palette %}
  <label>
    <input type="radio" name="{{ name }}" value="{{ color }}"{% if color in values %} checked{% endif %}>
    <span style="background: {{ color }}">{{ color }}</span>
  </label>
{% endfor %}

テンプレートで使える値

内容

name(標準のテンプレートでは {name})

値の入力の name。複数の値を送るときは {{ name }}[] にします。

values(標準のテンプレートでは {values.0}・{values.1}…)

保存済みの値の配列。

definition(標準のテンプレートでは {definition.key}・{definition.label}・{definition.type}・{definition.description}・{definition.config.<キー>})

定義。config に型ごとの設定が入ります。

  • field[] の宣言・:search・:v# は編集画面が出すため、テンプレートには書きません。

  • 標準のテンプレートでは BEGIN_IF などの条件分岐が使えません。選択状態など、条件分岐が要るときは .twig で書きます。

  • Twig では |raw を使わないでください。保存済みの値から XSS になります。

  • ファイルの入力(<input type="file">)は使えません。あると保存が止まります。

  • カスタムフィールドメーカーで作った HTML をそのまま貼らないでください。value="{キー}" のような書き方はこのテンプレートでは空になり、保存すると値を空で上書きします。

  • テーマ・プラグインの型は、フィールドグループの中では使えません(値は保持されます)。

  • 型の宣言はテンプレートのキャッシュに保存されます。宣言を変えたときは、テンプレートのキャッシュを削除すると読み直します。

値の保存・テンプレートでの出し方は、テキストの型と同じです({mytheme_color のキー} ではなく、定義したフィールドのキーで {キー} と書きます)。JS で見た目を作り込むときは、管理画面の JS イベント field-definition.field.rendered / field-definition.field.remove で、入力欄が入った・外れるタイミングを受け取れます(プラグインからの拡張)。

表示する場所

エントリーの編集画面などに、フィールドセットを出す場所を足します。

  1. themes/<テーマ>/admin/field-definitions/placements.json に場所を宣言します。

  2. 編集画面のテンプレート(エントリーなら admin/entry/edit.html など)の、<acms-custom-fields> と同じフォームの中に、同じ名前の差し込み口を置きます。

  3. フィールド定義の画面で、フィールドセットの「表示する場所」で足した場所を選び、「設定を保存」を押します。

{
  "version": 1,
  "placements": {
    "entry": [
      { "name": "top", "label": "一番上", "hint": "短い入力向きです。" }
    ]
  }
}
<acms-custom-fields-slot placement="top"></acms-custom-fields-slot>

キー

必須

内容

version

必須

1

placements

必須

対象(entry など)ごとの場所の配列。

name

必須

英小文字で始まる、英小文字・数字・ハイフン・アンダースコアの 32 文字以内。main は使えません。

label

必須

「表示する場所」の選択肢に出す名前。

hint

定義画面でその場所を選んだときに出す案内。

  • エントリーの foot(本文の下)・side(サイドバー)は標準の場所です。同じ名前を宣言しても無視されるため、別の名前にします。

  • 差し込み口が無い画面では、その場所のフィールドセットは <acms-custom-fields> の位置に出ます。差し込み口はフォームの外に置いても使われません。

  • 名前を変えると、その場所を選んだフィールドセットは標準の位置に戻ります。一度使った名前は変えないでください。

従来のカスタムフィールドとの併用と移行


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

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

併用の基本

  • 従来のテンプレートのカスタムフィールドは、そのまま動きます。定義の無いキーは、従来どおり確かめずに保存されます。

  • カスタムフィールド定義の入力欄は、テンプレートの入力欄の後ろに出ます(エントリーは本文の上)。

  • 定義の入力欄は、編集画面のフォームの中で acms_cf[キー] という名前で送られ、サーバーで元のキーに戻して保存されます。テーマの入力欄に acms_cf という name は使わないでください。

  • 保存される値の形は同じなので、公開側のテンプレートは方式によらず同じです。

同じキーをテンプレートと定義の両方に書いたとき

  • テーマのテンプレートが field[] で宣言しているキーがあると、編集画面はそのキーの定義の入力欄を出しません。保存もテンプレート側の値が優先されます(定義の側の値は保存されず、警告ログが残ります)。

  • フィールドグループも同じです。テーマに同じ名前のグループ(@グループ名)があると、定義の側は器ごと出しません。

  • ただし、定義で必須や入力チェックを設定したキーは、テンプレートの入力欄から送られた値にもサーバーで同じチェックが掛かります(定義もフィールドセットも有効で、条件で隠れていないとき)。

  • 定義のあるキーをテンプレートの入力欄で送るときも、従来どおり field[] の宣言が必要です。宣言が無く値だけを送ると、送られなかったものとして扱われ、保存済みの値に戻ります。

従来のフィールドを定義へ移す手順

テキスト・選択肢・日付など、派生キーを持たないフィールドを移す手順です。

  • 検証環境で作業し、移す前にデータベースのバックアップを取ります。

  • フィールドセットの編集画面の「使用中のフィールド」で「集計」すると、値はあるのに定義の無いキーが件数付きで並びます。移すキーを「定義に追加」し、テンプレートの入力欄と同じ型(<input type="text"> ならテキスト、name="キー[]" のチェックボックスなら複数選択のチェックボックス)を選びます。

  • ラベル・選択肢・必須・入力チェックを、テンプレートの入力欄(:v# の指定など)に合わせて設定します。選択肢の値は、テンプレートの value と同じにします。

  • テーマの field.html などから、そのキーの入力欄・field[] の宣言・:search・:v# の hidden をまとめて削除します(残っていると、定義の入力欄は出ません)。

  • 編集画面で、定義の入力欄に保存済みの値が入っていることを確かめてから保存し、公開側のテンプレートは変えずに、表示が変わらないことを確かめます。

フィールドグループ(@グループ名)は「使用中のフィールド」に出ません。型「フィールドグループ」を、キーをグループ名と同じにして作り、中にメンバーと同じキーのフィールドを作ってから、テーマの入力欄を削除します。

画像・ファイルのフィールドは移せません

テンプレートで作った画像・ファイルのフィールド(@path などの派生キーを持つもの)は、「テンプレート方式のフィールド(GUI 定義では扱えません)」の印が付き、定義に追加できません。テンプレート方式のまま使い続けてください。

同じキーでメディア画像の型を作ると、@path などの値はメディアの情報に置き換わり、元の画像は使われなくなります。メディアに移すときは、メディアライブラリに画像を登録して選び直します。

管理画面のテンプレートを上書きしているテーマ

システムテーマの編集画面には、定義の入力欄を出す次のモジュールが入っています。テーマで編集画面のテンプレートを上書きしていると、入力欄が出ません。その場合は次の手順で追記します。

  1. テーマが上書きしているファイルを確かめます。エントリーは admin/entry/edit.html と admin/_layouts/entry/edit.html、カテゴリー・ブログ・ユーザー・モジュールは admin/category/edit.html などです。

  2. admin/entry/edit.html を @extends("/admin/_layouts/entry/edit.html") で書き、@section("entry-field") を上書きしていなければ、追記は要りません。

  3. それ以外の場合は、カスタムフィールドの入力欄(field.html の読み込み)の後ろ、<form> の内側に次を追記します。

  4. エントリーで「本文の下」「サイドバー」を使うときは、field_foot.html・field_side.html を読み込んでいる位置の後ろに差し込み口も足します。

  5. 有効なフィールドセットがあるブログで編集画面を開き、入力欄が出て保存できることを確かめます。

<!-- BEGIN_MODULE Admin_FieldDefinition_CustomFields -->
<acms-custom-fields entity-type="entry" definitions="{definitions}[escvars]" values="{values}[escvars]"></acms-custom-fields>
<!-- END_MODULE Admin_FieldDefinition_CustomFields -->
<!-- カテゴリーの例。id と entity-type に category / blog / user / module を書く -->
<!-- BEGIN_MODULE Admin_FieldDefinition_CustomFields id="category" -->
<acms-custom-fields entity-type="category" definitions="{definitions}[escvars]" values="{values}[escvars]"></acms-custom-fields>
<!-- END_MODULE Admin_FieldDefinition_CustomFields -->
<acms-custom-fields-slot placement="foot"></acms-custom-fields-slot>
<acms-custom-fields-slot placement="side"></acms-custom-fields-slot>

追記しないまま使わないでください

入力欄が出ていなくても、定義の必須・入力チェックは保存時に掛かります。上書きしたテーマで追記を忘れると、画面に無い必須の項目で保存できなくなります。

定義に無い値・定義の削除

  • 定義を削除したり無効にしたりしたフィールドの値は、編集画面で保存しても消えないよう、そのまま送り直されます(画面には出ません)。この送り直しは、編集画面に定義の入力欄が出ているときに働きます。

  • キー名に「:」や「[ ]」を含むなど、送り直せない値は、編集画面に「保存すると消える値」として一覧で出ます。

  • 「使用中のフィールド」の「値があるのに定義の無いフィールド」で、定義の無い値を確かめられます。

  • 定義やフィールドセットを削除しても、データベースに保存済みの値は削除されません。

キーを変更する

フィールドの設定フォームの「キーを変更」で、新しいキーを入力して影響(書き換える値の件数、自動では書き換わらないもの)を確かめてから実行します。実行後に、テンプレート・テーマに書いた {古いキー} を新しいキーに書き換えます。編集中の内容は破棄されます。

保存済みの値(派生キーを含む)と、ほかの定義の表示条件・等価チェックの参照は、新しいキーに書き換わります。テンプレート・テーマは書き換わりません。エントリーなどの編集画面を閉じてから実行してください。テーマ・親ブログ由来の定義は、キーを変更できません。

エクスポートとインポート

別のブログや環境へ定義を移すときに使います。

移す元の定義画面でフィールドセットをエクスポートし(テーマ由来の定義も含めるときは「テーマ由来の定義も含める」を選びます。通常は含めません)、移す先の定義画面の同じ対象のタブでインポートします。JSON ファイルを選ぶか貼り付けると、フィールドセットごとの状態(「新規」「衝突」「変更なし」など)が確認できます。同じコードのフィールドセットがあるときは、「上書きする」か「スキップする」を選びます。上書きは、ファイルにあるフィールドを追加・更新し、ファイルに無い既存のフィールドは残します。

  • カテゴリー・ブログ・ロールの参照は、ID ではなくコード・名前で書き出し、取り込み先の ID に読み替えます。

  • ファイルは 1MB までです。

  • ブログのエクスポート・インポート(バックアップ)にも、フィールド定義が含まれます。

  • 書き出した JSON は、テーマに置ける形式です(テーマでフィールド定義を宣言する)。

よくあるつまずきと注意点


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

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

定義画面が開けない

管理メニューに「フィールド定義」が無い・開くと 403 になる

  • ロールを使っていないユーザーは、そのブログの管理者の権限が要ります。

  • ロールを使っているユーザーは、ロールの設定で「フィールド定義の編集」にチェックが要ります。

  • プレビュー中は開けません。

編集画面に入力欄が出ない

フィールドセットを作ったのに出ない

  • フィールドセットとフィールドの「有効にする」にチェックが入っているかを確かめます。

  • フィールドセットの「表示条件」を確かめます。エントリーのカテゴリーなどが条件に合わないと出ません。

  • テーマのテンプレートに同じキー(field[] の宣言)があると、定義の入力欄は出ません。テンプレート側を削除するか、キーを変えます。

  • テーマで編集画面のテンプレートを上書きしている場合、Admin_FieldDefinition_CustomFields の追記が要ります(従来のカスタムフィールドとの併用と移行)。

  • モジュール ID では、「カスタムフィールドを表示」にチェックが要ります。

  • 「権限・ロール別の表示」で「表示しない」になっていないかを確かめます(管理者には常に出ます)。

「本文の下」「サイドバー」を選んだのに標準の位置に出る

  • 編集画面のテンプレートに、その場所の差し込み口(<acms-custom-fields-slot>)がありません。差し込み口は <acms-custom-fields> と同じフォームの中に置きます。

コンポーネントのフィールドが何も出ない

  • 使うコンポーネントが見つからないか、無効になっています。定義画面のカードの表示(「使うコンポーネントが見つかりません。」など)を確かめます。

  • 展開後のキーがほかのキーと重なるか、64 文字を超えると展開しません。

保存できない

「入力欄が出ていない項目にエラーがあります」と出る

  • 権限・ロールや表示条件で画面に出ていない項目が、必須・入力チェックに失敗しています。必須は画面に出ているかどうかに関係なく、保存時に確かめます。

  • 急いで回避するときは、その定義の「有効にする」を外します。

公開ボタンや一覧から公開できない

  • 「公開時に必須」の項目が空です。一覧からまとめて公開したときは「公開時に必須の項目が未入力のため、…件のエントリーを公開しませんでした。」と表示されます。エントリーを開いて入力してから公開します。

数値・メールアドレス・選択肢の値で保存が止まる

  • これらの型は、型に合う値かを保存時に確かめます。CSV インポートでも確かめます。選択肢の型は、値が選択肢にある必要があります。

独自の型(テンプレート型)のフィールドがあると保存が止まる

  • 入力欄のテンプレートにファイルの入力(<input type="file">)があると、保存が止まります。画像・ファイルはメディアの型を使います。

値が消える・保存されない

隠れたフィールドの値が消えた

  • 「非表示のときは値を保存しない」を選んでいると、条件付き表示で隠れたまま保存したときに値が消えます。

項目ごとにブロックを選ぶフィールドグループの値が消えた

  • 項目のブロックを選び直すと、前のブロックの欄の値は保存したときに消えます。

モジュール ID の値が消えた

  • 「カスタムフィールドを表示」を外して保存すると、そのモジュール ID の定義の値は保存されず、それまでの値も消えます。

JS で入力欄の値を書き換えても保存されない

  • 定義の入力欄は React で描いています。DOM の value を直接書き換えても保存されません。JS イベント field-definition.value.set を使います(プラグインからの拡張)。

  • フィールドグループの項目の入力には name がありません。テーマの JS が name で入力を探していると見つかりません。

テンプレートで値が出ない

何も出ない

  • 書く場所(モジュール)を確かめます。エントリーのカスタムフィールドは entry:loop の中か Entry_Field の中に書きます(テンプレートでの出力(基本の型))。

  • キーの綴りを、定義画面のカードのキーと比べます。コンポーネントのフィールドは、展開後のキー(<フィールドのキー>_<中のキー>)で書きます。

画像が表示されない・ファイルのリンクが壊れる

  • メディア画像の {キー@path} は相対パスなので、%{MEDIA_ARCHIVES_DIR}{キー@path} と書きます。メディアファイルの {キー@path} は /media-download/… から始まるので、何も付けません。

選択肢の表示名ではなく値が出る

  • 仕様です。選択肢の型は値を保存します。BEGIN_IF で読み替えます。

メディアギャラリー・複数の参照がループで出ない

  • ループの名前に派生キーまで書きます(<!-- BEGIN キー@path:loop -->、<!-- BEGIN キー@title:loop -->)。ループの中で値が出るのは、その派生キーだけです(ギャラリーの {キー@alt}、複数の参照の {キー@url} は空になります)。

  • 代わりの書き方は、ギャラリーなら添字({キー@alt[1]}。0 から数えます)、Twig、メディア画像をフィールドグループに入れる方法です。複数の参照は Twig か、参照(1 件)をフィールドグループに入れる方法です。

参照先が出ない

  • 参照先が下書き・非公開・公開期間外・削除済みだと出しません。

Twig で値の型が思ったものと違う

  • 数字だけの値は数値に、true / false は真偽値に、空は null になります。チェック時の値を 1 にしたチェックボックスは数値の 1 になります。

型・キーが使えない

キーが使えない

型が選べない

  • 「Pro」の印が付いた型は、プロフェッショナルライセンス以上で使えます。

  • アーカイブ画像・アーカイブファイルは、ユーザーの定義だけで選べます。

  • タブはタブの入れ物の中に、ブロックは「項目ごとにブロックを 1 つ選ぶ」フィールドグループの直下にだけ置けます。

  • フィールドグループの中には、複数の値を持つ型・隠し値・地図などは置けません。

テーマの宣言が効かない

定義画面に「テーマ」の定義が出ない

  • 監査ログの警告を確かめます。JSON として読めない、version や entityType が違う、1MB を超えるファイルは読みません。

  • ファイル名が対象と合っているか(admin/field-definitions/entry.json など)を確かめます。

  • そのテーマを使っているブログかを確かめます。子孫のブログには継承されません。

テーマの定義が編集画面に出ない

  • 同じキーの定義を管理画面で作ると、管理画面の定義が優先されます。

  • そのブログで「このブログでは使わない」にしていないかを確かめます。

  • カテゴリーなどの参照を読み替えられないと、その定義は無効(close)で読み込まれます。

独自の型の変更が反映されない

  • 型の宣言はテンプレートのキャッシュに保存されます。テンプレートのキャッシュを削除します。

placements.json の場所が選べない

  • foot・side などの標準の場所と同じ名前は無視されます。別の名前にします。

プラグインからの拡張


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

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

カスタムフィールド定義は、コアを改修せずに、プラグインから型や場所を足せます。登録は、プラグインの ServiceProvider::init() で、ファサード Acms\Services\Facades\FieldDefinition を使って行います。公開している拡張の入口は、雛形の Hook(extension/acms/Hook.php)と、管理画面の JS の拡張点の一覧(@ablogcms/plugins の HOOKS.md)に載っているものです。

登録の例

カレンダーの型・表示する場所・表示条件の項目・パターンを登録する ServiceProvider です。

<?php

namespace Acms\Plugins\MyCalendar;

use ACMS_App;
use Acms\Services\Common\HookFactory;
use Acms\Services\Facades\FieldDefinition;
use Acms\Services\Facades\Twig;

class ServiceProvider extends ACMS_App
{
    public $version = '1.0.0';
    public $name = 'MyCalendar';
    public $author = 'example';
    public $module = false;
    public $menu = false;
    public $desc = 'カレンダーのフィールド型';

    public function init()
    {
        HookFactory::singleton()->attach('MyCalendarHook', new Hook());

        // .twig をプラグインのディレクトリから読むために登録する(@mycalendar/... で参照できる)
        Twig::addTemplatePath(PLUGIN_LIB_DIR . 'MyCalendar/template', 'mycalendar');

        FieldDefinition::registerFieldType('mycalendar.date', [
            'label' => 'カレンダー',
            'template' => '@mycalendar/field-types/calendar.twig',
            'icon' => 'calendar_month',
            'configFields' => [
                ['key' => 'format', 'label' => '日付フォーマット', 'type' => 'text', 'default' => 'Y-m-d'],
            ],
            'validators' => ['regex'],
        ]);

        FieldDefinition::registerPlacement('entry', 'mycalendar-schedule', '日程', '日付の入力向けです。');

        FieldDefinition::registerLocationSubject('mycalendar.season', [
            'label' => '季節',
            'entityTypes' => ['entry'],
            'kind' => 'enum',
            'options' => [
                ['value' => 'summer', 'label' => '夏'],
                ['value' => 'winter', 'label' => '冬'],
            ],
            'provider' => static function (string $entityType, int $blogId, ?int $userId, array $values): string {
                $month = (int) date('n');
                return ($month >= 6 && $month <= 9) ? 'summer' : 'winter';
            },
        ]);

        FieldDefinition::registerPatternDirectory(PLUGIN_LIB_DIR . 'MyCalendar/patterns');
    }
}
{# extension/plugins/MyCalendar/template/field-types/calendar.twig #}
<input type="text" name="{{ name }}" value="{{ values[0] ?? '' }}"
  class="js-mycalendar" data-format="{{ definition.config.format ?? 'Y-m-d' }}">

独自のフィールド型を登録する

FieldDefinition::registerFieldType(string $key, array $options): void で型を登録します。

オプション

必須

内容

既定値

label

必須

型を選ぶ画面の名前。

—

template

必須

入力欄のテンプレート。.twig のパス、テーマの中の標準のテンプレートのパス、または HTML を返す関数(function (array $context): string)。

—

icon

アイコン名。

空

configFields

型ごとの設定の欄(key・label・type・description・default)。

なし

validators

入力チェックで選べる項目のメソッド名。required・password・filesize・converter・duplication は書いても選べません。

なし

edition

standard か professional。

standard

entityTypes

使える対象の配列。

すべて

category

分類。@ で始まる名前。

@custom

requiresFieldStorage

値の処理をコアのカスタムフィールドの保存処理に頼るか。

false

configReferences

設定にカテゴリー・ブログ・ユーザー・ロールの ID を持つとき、設定のキーと種類(category・blog・user・role)。エクスポートやブログのインポートで読み替えます。

なし

  • キーは vendor.type の形を勧めます(64 文字以内)。コアの型のキーは使えず、例外になります。

  • 同じキーの型がテーマにもあると、テーマの型が優先されます。

  • template に文字列のパスを書くと、.twig 以外はテーマの中だけを探します。プラグインのディレクトリのテンプレートを使うときは、Twig::addTemplatePath() で登録した .twig か、関数にします。

  • テンプレートや関数には definition(定義)・name(値の入力の name)・values(保存済みの値の配列)が渡ります。値の入力は name だけで書き、field[]・:v# は書きません。

出力は必ずエスケープしてください

テンプレートや関数の出力は、そのまま編集画面に入ります。Twig では |raw を使わないでください。保存済みの値から XSS になります。

場所・表示条件・定義・パターンを足す

メソッド

内容

registerPlacement(string $entityType, string $name, string $label, ?string $hint = null): void

フィールドセットの「表示する場所」の選択肢を足します。編集画面のテンプレートに <acms-custom-fields-slot placement="名前"> を置きます。エントリーの main・foot・side はコアの名前のため使えません(例外になります)。

registerLocationSubject(string $name, array $options): void

フィールドセットの表示条件に項目を足します。名前は vendor.name の形です。

registerThemeDefinitionDirectory(string $directory): void

ディレクトリに置いた <対象>.json を、テーマの宣言と同じように読みます。テーマの宣言より優先度は低くなります。

registerPatternDirectory(string $directory): void

ディレクトリに置いたパターンの JSON を「パターン」に並べます。テーマのパターンの後、標準のパターンの前に並びます。

registerLocationSubject() のオプションです。

オプション

必須

内容

既定値

provider

必須

値を返す関数(Closure)。fn(string $entityType, int $blogId, ?int $userId, array $values): string。

—

label

表示条件の選択肢に出す名前。

名前

entityTypes

'all' か対象の配列。

'all'

kind

text か enum。

text

operators

使える条件。text は eq・neq・contains・matches・empty・notEmpty、enum は in・eq・neq の中から選びます。

kind のすべて

options

enum のとき必須

value と label の配列。

—

ファイルの形は、テーマと同じです(テーマでフィールド定義を宣言する、テーマでパターン・独自の型・表示する場所を足す)。

Hook

雛形の Hook にある、カスタムフィールド定義の拡張点です。プラグインでは HookFactory::singleton()->attach() で Hook のクラスを登録します。

Hook

いつ呼ばれるか

extendsFieldDefinitions(array &$sets, string $entityType)

有効なフィールドセットを編集画面へ渡す前。保存時のチェックと、公開側の参照切れの判定にも同じ加工が効きます。

extendsFieldDefinitionValue(\Field_Validation $field, string $key, array $definition)

保存時、値を保存する定義のキーごと(必須・入力チェックの前)。値の整形や、派生キーを作るときに使います。

extendsFieldVisibility(string &$level, array $definition, array $context)

権限・ロール別の表示を決めた後。$level は editable・readonly・hidden。

extendsFieldTypePolicy(array &$policy, string $entityType, int $blogId)

選べる型を決めるとき。allow / deny に型のキーか分類(@inputs・@choices・@media・@relations など)を書いて絞れます。エディションの制限は緩められません。

extendsThemeFieldDefinitions(array &$sets, string $entityType, string $file)

テーマの宣言ファイルを読んだ後。

extendsInheritedFieldDefinitions(array &$sets, string $entityType, int $blogId)

親ブログから継承する定義を決めた後。

extendsKeyRenamed(string $entityType, int $blogId, string $oldKey, string $newKey, int $rows)

キーを変更した後。

extendsRelationPickerQuery(\SQL_Select $sql, string $type, array $scope)

参照の型で、選択肢の一覧を作るとき。条件を足して候補を絞れます(アクセス制御には使えません)。

extendsRelationBrokenReference(?string &$replacement, string $type, string $key, string $value, string $entityType, int $blogId)

公開側で、存在しない参照先を出すとき。

extendsFieldDefinitionSearchReindexBefore / extendsFieldDefinitionSearchReindex / extendsFieldDefinitionSearchReindexAfter

定義の変更をキーワード検索に反映する前・対象ごと・後。

extendsFieldDefinitionExport(array &$profile, string $entityType, int $blogId)

定義をエクスポートするとき。

extendsFieldDefinitionImport(array &$profile, string $entityType, int $blogId)

定義をインポートするとき。例外を投げると取り込みません。

extendsFieldDefinitionImportRoleId(?int &$roleId, string $original, array $context)

インポートで、ロールの参照を読み替えるとき。

<?php

namespace Acms\Plugins\MyCalendar;

class Hook
{
    /**
     * 保存時に、値を保存する定義のキーごとに呼ばれる
     */
    public function extendsFieldDefinitionValue(\Field_Validation $field, string $key, array $definition): void
    {
        if (($definition['type'] ?? '') !== 'mycalendar.date') {
            return;
        }
        $field->set($key, str_replace('/', '-', (string) $field->get($key)));
    }

    /**
     * 選べる型を決めるときに呼ばれる。ユーザーの定義ではブロックエディターを選べなくする
     */
    public function extendsFieldTypePolicy(array &$policy, string $entityType, int $blogId): void
    {
        if ($entityType === 'user') {
            $policy['deny'][] = 'block-editor';
        }
    }
}

引数の詳細と例は、雛形の Hook のコメントを参照してください。

管理画面の JS イベント

ACMS.events で購読します。

イベント

種類

内容

field-definition.field.rendered

通知

テンプレートの型の入力欄を DOM に入れた直後(要素につき 1 回)。payload は { element, definition, name }。

field-definition.field.remove

通知

入力欄を DOM から外す直前。描き直すときは remove → rendered の順で発火します。rendered で付けたものをここで片付けます。

field-definition.value.set

通知

JS から編集画面の値を書き換える口。ACMS.events.notify('field-definition.value.set', { entityType, key, values }) と呼びます。読み取り専用・非表示のキー、フィールドグループのメンバーは書き換えません。

field-definition.label.before

ゲート

項目のラベルを書き換えます。payload は { locale, labels }。

field-definition.visibility.after

通知

編集画面を開いたときの、権限・ロール別の表示の結果(制限のあるキーだけ)。

field-definition.import.success

通知

定義をインポートした後。

field-definition.search-reindex.after

通知

検索対象の変更をキーワード検索に反映した結果。

field-definition.suppress.change

通知

テーマ・継承の定義を「使わない/使う」に切り替えた後。

field-definition.key.change

通知

キーを変更した後。

const mounted = new WeakMap();

ACMS.events.on('field-definition.field.rendered', ({ element, definition }) => {
  if (definition.type !== 'mycalendar.date') {
    return;
  }
  const input = element.querySelector('.js-mycalendar');
  // input にカレンダーを付け、片付けの関数を覚えておく
  mounted.set(element, () => {
    // カレンダーを外す
  });
});

ACMS.events.on('field-definition.field.remove', ({ element }) => {
  mounted.get(element)?.();
  mounted.delete(element);
});

JS の読み込みは、InjectTemplate::add() で管理画面に <script type="module"> を差し込む形で行います。

実験的な API

次の API は experimental です。公開 API として固まっておらず、変わる可能性があります。

  • FieldDefinition::registerEntityType(string $name, array $options = []): コメント・フォームなどのプラグインが、自分の持ち主(対象)に定義を使うための登録。値はプラグインが自前のテーブルに保存します。

  • FieldDefinition::validateValues(string $entityType, int $blogId, \Field_Validation $values, string $status = 'open', ...) と FieldDefinition::validateValuesWithSets(...): 定義で値を確かめ、結果を返します。

  • 管理画面の定義画面の部品(@ablogcms/field-definition)