acf_add_local_field()


WordPressのacf_add_local_field()関数は、Advanced Custom Fields(ACF)プラグインを使って、カスタムフィールドをローカルに登録するために使用されます。この関数を使用することで、フィールドをプログラム的に追加できます。

構文

acf_add_local_field( array $field );
  • $field (array) — フィールドの設定を定義する連想配列。

例 1: シンプルなテキストフィールドの追加

シンプルなテキストフィールドを追加する例です。

<?php
acf_add_local_field( array(
    'key' => 'field_1',
    'label' => 'テキストフィールド',
    'name' => 'text_field',
    'type' => 'text',
    'parent' => 'group_1'
) );
?>

例 2: 選択肢フィールドの追加

選択肢を持つフィールドを追加する例です。

<?php
acf_add_local_field( array(
    'key' => 'field_2',
    'label' => '選択肢',
    'name' => 'select_field',
    'type' => 'select',
    'choices' => array(
        'option_1' => 'オプション 1',
        'option_2' => 'オプション 2'
    ),
    'parent' => 'group_1'
) );
?>

例 3: 日付ピッカーの追加

日付を選択できるフィールドを追加する例です。

<?php
acf_add_local_field( array(
    'key' => 'field_3',
    'label' => '日付',
    'name' => 'date_field',
    'type' => 'date_picker',
    'parent' => 'group_1'
) );
?>

例 4: チェックボックスフィールドの追加

複数選択可能なチェックボックスフィールドを追加する例です。

<?php
acf_add_local_field( array(
    'key' => 'field_4',
    'label' => 'チェックボックス',
    'name' => 'checkbox_field',
    'type' => 'checkbox',
    'choices' => array(
        'checkbox_1' => 'チェックボックス 1',
        'checkbox_2' => 'チェックボックス 2'
    ),
    'parent' => 'group_1'
) );
?>

例 5: WYSIWYGエディタフィールドの追加

リッチテキストエディタを追加する例です。

<?php
acf_add_local_field( array(
    'key' => 'field_5',
    'label' => 'リッチテキスト',
    'name' => 'wysiwyg_field',
    'type' => 'wysiwyg',
    'parent' => 'group_1'
) );
?>

例 6: 隠しフィールドの追加

ユーザーが見ることのできない隠しフィールドを追加する例です。

<?php
acf_add_local_field( array(
    'key' => 'field_6',
    'label' => '隠しフィールド',
    'name' => 'hidden_field',
    'type' => 'hidden',
    'parent' => 'group_1'
) );
?>

注意事項

  • $field['key']は必須です。同じキーを複数回使用することはできません。
  • $field['parent']にはグループのキーを設定します。これがないと、フィールドは正しく表示されません。
  • カスタムフィールドの設定は、acf_add_local_field()を呼び出す前に適切に構成する必要があります。