acf_get_choices_from_terms()

関数acf_get_choices_from_terms()は、WordPressのAdvanced Custom Fields（ACF）プラグインで使用される関数で、指定されたタクソノミーのタームを選択肢として取得します。この関数は、ACFの選択肢フィールドなどで利用されることが多いです。

構文

acf_get_choices_from_terms( array $args = array() );

引数の説明:

• $args(array) — タームを取得するための引数を指定します。以下のキーを持つ連想配列です。
• taxonomy(string) — タームを取得するタクソノミーを指定します。
• hide_empty(bool) — 空のタームを非表示にするかどうかを指定します。デフォルトはfalseです。
• orderby(string) — タームの並び順を指定します。デフォルトはnameです。
• order(string) — 並び順の方向を指定します。ASCまたはDESCを指定できます。デフォルトはASCです。
• include(array) — 取得するタームのIDを配列で指定します。
• exclude(array) — 除外するタームのIDを配列で指定します。

例1: カテゴリータクソノミーのタームを取得

カテゴリータクソノミーのタームを選択肢として取得します。

$choices = acf_get_choices_from_terms( array( 'taxonomy' => 'category' ) );

例2: 空のタームを非表示にしてタームを取得

空のタームを非表示にして、タグタクソノミーのタームを取得します。

$choices = acf_get_choices_from_terms( array( 'taxonomy' => 'post_tag', 'hide_empty' => true ) );

例3: タームを名前順で降順に取得

タームを名前順で降順に並べ替えて取得します。

$choices = acf_get_choices_from_terms( array( 'taxonomy' => 'category', 'orderby' => 'name', 'order' => 'DESC' ) );

例4: 特定のタームIDのみを取得

指定したタームIDのみを取得します。

$choices = acf_get_choices_from_terms( array( 'taxonomy' => 'category', 'include' => array( 1, 2, 3 ) ) );

例5: 特定のタームIDを除外して取得

指定したタームIDを除外してタームを取得します。

$choices = acf_get_choices_from_terms( array( 'taxonomy' => 'category', 'exclude' => array( 4, 5 ) ) );

注意点

• タクソノミーが存在しない場合、空の配列が返されます。
• 取得したタームは、ACFの選択肢フィールドなどで利用するために適しています。