概要
get_comments_number() 関数は、特定の投稿ページのコメント数を取得するために使用されます。この関数は、特定の投稿に対するユーザーの反応を確認したり、コメント機能がどれだけ利用されているかを把握するために役立ちます。一般的に、以下のような機能を実装する際に用いられます。
- コメント数を表示するためのテンプレートタグ
- 投稿リストでのコメント数の表示
- 動的にコメント数に基づくスタイリングを行うとき
- 投稿の人気度を測定するウィジェットの作成
- コメントがあるかどうかの判定を行う条件分岐
- 投稿のメタ情報をカスタマイズする際の参考データ
- コメント数をフィルタリングしてカスタムクエリを作成する際
- 他のプラグインやテーマに連携して統計情報を表示する場合
関数の構文は次の通りです。
get_comments_number( $post_id = 0 );
パラメータ
$post_id（オプション）：対象の投稿のID。指定しない場合は、現在の投稿を基準にする。
戻り値
コメントの総数（整数値）。
関連する関数
使用可能なバージョン
get_comments_number() 関数は WordPress 1.5.0 以降で使用可能です。
コアファイルのパス
wp-includes/comment.php
サンプルコード
サンプルコード1: 基本的な使用例
<?php
$post_id = get_the_ID(); // 現在の投稿のIDを取得
$comments_number = get_comments_number($post_id); // コメント数を取得
echo "この投稿のコメント数: " . $comments_number; // コメント数を表示
?>
このサンプルコードは、現在の投稿に対するコメント数を取得し、表示します。
サンプルコード2: 投稿リストでのコメント数表示
<?php
if (have_posts()) {
while (have_posts()) {
the_post();
$comments_number = get_comments_number();
echo '<h2>' . get_the_title() . ' (' . $comments_number . ' コメント)</h2>'; // 投稿タイトルとコメント数を表示
}
}
?>
このコードは、投稿リストで各投稿のタイトルとコメント数を表示します。
サンプルコード3: コメント数によるスタイリング
<?php
$comments_number = get_comments_number();
if ($comments_number > 0) {
echo '<div class="has-comments">コメントがあります</div>'; // コメントがある場合のスタイリング
} else {
echo '<div class="no-comments">コメントがありません</div>'; // コメントがない場合のスタイリング
}
?>
このコードは、コメント数に応じて異なるメッセージを表示するスタイリングを実施しています。
サンプルコード4: 特定の投稿のコメント数取得
<?php
$post_id = 123; // 特定の投稿ID
$comments_number = get_comments_number($post_id);
echo "投稿ID {$post_id} のコメント数: " . $comments_number; // 特定投稿のコメント数を表示
?>
このサンプルでは、特定の投稿IDに基づいてコメント数を取得し、表示しています。
サンプルコード5: コメント数を基にした条件分岐
<?php
$comments_number = get_comments_number();
if ($comments_number > 10) {
echo '人気の投稿です！'; // コメント数が10以上の場合のメッセージ
}
?>
このコードは、コメント数が10以上であれば特定のメッセージを表示します。
この関数のアクションでの使用可能性
| アクション名 | 使用可能性 |
|---|---|
| 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 |
特定のワードプレスバージョンでこの関数が非推奨又は削除された場合はありません。