概要
wp_count_terms関数は、指定したタクソノミー内のターム数を取得するための関数です。この関数は、サイトの内容を整理したり、分析したりする際によく使用されます。具体的には以下のような機能で役立ちます。
- カスタムタクソノミーのターム数を取得する
- タグやカテゴリの総数を表示する
- 自動的にターム数を更新する
- 特定の条件に基づいたターム数のフィルタリング
- ダッシュボードウィジェットの作成
- 投稿のメタデータとしてターム数を使用する
- タームの一覧を表示する際のページネーションに利用する
- SEO分析やレポート作成に役立てる
構文
wp_count_terms( $taxonomy, $args );
パラメータ
$taxonomy(string) 必須 – タクソノミーの名前を指定します。$args(array) オプション – 追加のクエリ引数を指定します。
戻り値
wp_count_terms関数は、タクソノミー内のターム数を整数で返します。
関連する関数
使用可能なバージョン
wp_count_terms関数は、WordPress 3.1.0で追加されました。
コアファイルのパス
wp-includes/taxonomy.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
サンプルコード
サンプル1: タクソノミーのターム数を取得する
$count = wp_count_terms( 'category' );
echo 'このサイトのカテゴリ数は ' . $count . ' です。';
このコードは、WordPressサイト内のカテゴリのターム数を取得し、表示します。
サンプル2: 特定のタクソノミーのターム数をフィルタリング
$args = array( 'hide_empty' => true );
$count = wp_count_terms( 'post_tag', $args );
echo '使用されているタグの数は ' . $count . ' です。';
このコードは、使用されているタグのターム数のみを表示します。
サンプル3: タクソノミーのターム数を管理画面で表示
if ( is_admin() ) {
add_action( 'admin_menu', function() {
add_dashboard_page( 'ターム数', 'ターム数表示', 'manage_options', 'term_count', 'display_term_count' );
});
function display_term_count() {
$count = wp_count_terms( 'custom_taxonomy' );
echo '<h1>ターム数</h1>';
echo '<p>カスタムタクソノミーのターム数は ' . $count . ' です。</p>';
}
}
このコードは、WordPressの管理画面のダッシュボードにカスタムタクソノミーのターム数を表示します。
サンプル4: ターム数を使ったSEOレポートの作成
$count = wp_count_terms( 'category' );
$seo_report = "このサイトには " . $count . " のカテゴリがあります。";
file_put_contents( 'seo_report.txt', $seo_report );
このコードは、サイトのカテゴリ数を計算し、その結果をSEOレポートファイルに保存します。
サンプル5: 投稿ごとのターム数を表示
global $post;
$terms = wp_get_post_terms( $post->ID, 'category' );
echo 'この投稿には ' . count( $terms ) . ' のカテゴリがあります。';
このコードは、特定の投稿に関連付けられたカテゴリのターム数を表示します。