勉強会

study

カスタムフィールド、カスタムユニットについて

カスタムフィールドとは

エントリーや、カテゴリー・ブログ・ユーザーに対して独自のデータを追加することができる機能(入力項目化)です。
追加したデータは表示や検索用のキーとして利用されます。

参考
https://developer.a-blogcms.jp/document/customfield/

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

サイト名、電話番号、住所などサイト内で汎用的に表示させるテキストや、
TOPページなどで定期的に更新したい文章や画像などがある場合よく使います。
管理画面の「ブログ」のカスタムに表示されます。

参考
https://developer.a-blogcms.jp/document/customfield/blog.html

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

ページタイトルの背景画像の設定やカテゴリの英語テキストをつけたい場合などによく使います。
管理画面の「カテゴリー」の各カテゴリーのカスタムに表示されます。

参考
https://developer.a-blogcms.jp/document/customfield/category.html

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

特定のカテゴリー配下だけ入力項目をつけたい場合などによく使います。
例えば採用ページなどで複数募集職種がある場合など、
募集要項の項目があらかじめエントリーに表示させたりできます。
各エントリーの編集画面に表示されます。

参考
https://developer.a-blogcms.jp/document/customfield/entry.html

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

あまり使う機会はないですが、ユーザーのプロフィール情報の入力項目を用意して表示させたりするのに良いかもです。
管理画面の「ユーザー」の各ユーザーのカスタムに表示されます。

参考
https://developer.a-blogcms.jp/document/customfield/user.html

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

これもあまり使う機会ないですが、表示したい見出しなどを入力項目化しておくと
モジュールのテンプレファイルを減らすことができるので良いかもです。
管理画面の「モジュールID」のカスタムに表示されます。

参考
https://developer.a-blogcms.jp/document/customfield/entry-2136.html

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

単体の項目であるカスタムフィールドを複数まとめて取り扱うことができる機能です。カスタムフィールドの項目を追加したり、削除したりすることができます。

参考
https://developer.a-blogcms.jp/document/customfield/group.html

カスタムユニット

コンテンツを「ユニット」と呼ばれるブロックに分けて登録・更新します。
ユニットは主にHTMLのブロック要素単位で入力欄を用意して、テキストを登録したり画像を登録するためのものです。
カスタムユニットはコンテンツの内容に合わせたオリジナルのユニットを作成できます。

カスタムユニットの設定方法

入力用のテンプレート

使用中のテーマ/admin/entry/unit/extend.html
ファイルを作成しコードを入力します。

<!-- BEGIN custom_test -->
ここの中にソースコードを記述
<!-- END custom_test -->

ユニット名は任意ですが必ず頭に「custom_」をつける必要があります。

出力用のテンプレート

使用テーマ/include/unit/extend.html
ファイルを作成しコードを入力します。

<!-- BEGIN unit#custom_test -->
ここに表示内容のソースコードを記述
<!-- END unit#custom_test -->

管理画面側の設定

管理画面 > コンフィグ > 編集設定 より
モードは「拡張」+「custom_任意の文字列」、ラベルは任意の名前を設定し保存します。
その後、管理画面 > コンフィグ > ユニット設定 より
1番下に追加したカスタムユニットの枠ができるのでユニットを選択し保存します。

エントリーのカスタムフィールドとカスタムユニットの違い

カスタムフィールドはエントリーの最上部または最下部にのみ表示され、他のユニットの間には挿入できませんが、
カスタムユニットの場合は他のユニットの間に挿入できます。

カスタムフィールドメーカー

フィールドのタグの書き方を覚えておくことは大事ですが、1つ1つ書いていくのは大変なのでカスタムフィールドメーカーを使用すると楽です。
https://developer.a-blogcms.jp/tools/custom-field.html
※上記ページはa-blog cms最新バージョンに対応したツールになります。
CMSが古いバージョンだと動かないことがあるので管理画面かの「コンフィグ」の中にあるカスタムフィールドメーカーを使用することを推奨します。