Advanced Custom Fields PRO 命名

概要

弊社で標準インストールするプラグイン「Advanced Custom Fields PRO」。

管理画面作成には欠かせないプラグインで、作成したい管理画面が、これひとつでほぼ全て作成できます。

しかし、自由に何でもできる反面、使用規定がないとシステム構築ロスが発生し、管理にも支障をきたします。

このプラグインの命名規定を弊社では厳格に取り決めています。

命名規則

基本命名

とてもシンプルです。カスタム投稿タイプの名前が「xxx」で入力欄が「開催日」の場合、「xxx_date」となります。

開催日初日と終了日なら「xxx_datestart」「xxx_dateend」としています。

固定ページなら「xxx」の箇所がページのslugになります。

※ アンダーバーひとつで区切られるようにしています。

繰り返しフィールドやグループの場合の命名

これらは、入れ子になりますが、上記の基本命名規則で入力した後、子や孫は prefix なしで、「texts」や「pic」「caption」のように命名します。

postmeta テーブル内での meta_key

基本命名したものが、それぞれ meta_key フィールドに保存されています。

グループの場合は、例えば「xxx_event」内の「date」の meta_key は、「xxx_event_date」になります。

※ 孫があれば「xxx_event_date_start」。

繰り返しフィールドは、「xxx_event_0_date」「xxx_event_1_date」・・といったものになります。

命名規則があるとDB内の値を参照する際も直感的に何の値か分かります。

get_post_meta や wpdb を使わないといけない場合などの参考にしてください。

※ get_field があるため、滅多に使いません。