概要
get_terms
関数は、WordPressで特定のタクソノミーに関連するターム(用語)情報を取得するために広く使用されます。この関数は、カスタムタクソノミーやカテゴリのリストを表示する際などに便利です。以下のような機能を実装する際によく使われます。
- カテゴリーやタグの一覧表示
- ポートフォリオやイベントのフィルタリング
- サイドバーやフッターにおけるタクソノミーリストの表示
- カスタム検索フィルタ
- クライアントのフィードバックを基にしたデータ統計
- 関連記事のターム情報の取得
- 商品の属性によるフィルタリング
- SEOのためのタクソノミー最適化
構文
get_terms( $taxonomies, $args );
パラメータ
$taxonomies
(文字列または配列): 取得するタクソノミーのスラッグ。$args
(配列): タームを取得するための追加オプション。
戻り値
取得したタームの配列。該当するタームが存在しない場合は空の配列を返します。
関連する関数
https://refwp.com/?titleonly=1&s=get_terms
使用可能なバージョン
get_terms
関数は、WordPress 2.3.0以降で使用可能です。
コアファイルのパス
wp-includes/taxonomy.php
サンプルコード
サンプルコード1: 特定のタクソノミーからタームを取得
このコードは、カスタムタクソノミー「genre」のタームを全て取得して表示します。
$terms = get_terms( 'genre' );
foreach ( $terms as $term ) {
echo $term->name . '<br>';
}
サンプルコード2: 引数を使ってタームをフィルタリング
引数を使って、特定の条件を満たすタームのみを取得する例です。この例では、「hide_in_menu」が0のタームのみを取得します。
$args = array(
'hide_empty' => false,
'meta_query' => array(
array(
'key' => 'hide_in_menu',
'value' => 0,
'compare' => '='
)
)
);
$terms = get_terms( 'custom_taxonomy', $args );
サンプルコード3: タームのカウントを取得
タームの数を取得して、それを表示するコードです。
$terms = get_terms( 'category' );
echo 'Total categories: ' . count( $terms );
サンプルコード4: タームのリンクを表示
取得したタームのリンクを表示するコードです。
$terms = get_terms( 'post_tag' );
foreach ( $terms as $term ) {
echo '<a href="' . get_term_link( $term ) . '">' . $term->name . '</a><br>';
}
サンプルコード5: すべてのタクソノミーを取得
サイト内のすべてのタクソノミーを取得して、その名前を表示するコードです。
$taxonomies = get_taxonomies();
foreach ( $taxonomies as $taxonomy ) {
echo $taxonomy . '<br>';
}
この関数のアクションでの使用可能性
アクション | 使用例 |
---|---|
mu_plugin_loaded | |
registered_post_type | |
plugins_loaded | |
wp_roles_init | |
setup_theme | |
after_setup_theme | |
set_current_user | |
init | 〇 |
register_sidebar | |
wp_loaded | 〇 |
send_headers | |
parse_query | |
pre_get_posts | 〇 |
wp | 〇 |
template_redirect | |
get_header | |
wp_head |
非推奨または削除されたWordPressバージョン
特定のWordPressバージョンで非推奨または削除されていません。