ワードプレスのget_comment_count関数の使用方法・解説

概要

get_comment_count関数は、指定した投稿に対するコメント数を取得するために使用されます。この関数は、主に以下の機能を実装する際に利用されることが一般的です：

1. 投稿に対するコメント数を表示する。
2. コメントがない場合の処理を行う。
3. ユーザーのコメント活動を分析する。
4. コメント数に基づくフィルタリング機能を実装する。
5. 独自のコメントリストを作成する。
6. コメント数によるUI要素の動的な表示。
7. 投稿の承認状況を反映するためのロジック。
8. コメント数に基づいたレポート作成。

構文

get_comment_count( $post_id, $approve = true );

パラメータ

• $post_id (integer): コメント数を取得したい投稿のID。
• $approve (boolean): 承認されたコメントのみをカウントするかどうかのフラグ。デフォルトは true。

戻り値

• 戻り値は配列で、以下のキーを持ちます:
  • approved: 承認されたコメントの数。
  • pending: 承認待ちのコメントの数。
  • total_comments: 総コメント数。

関連する関数

• wp_count_comments
• get_comments
• comment_form

使用可能なバージョン

この関数は、WordPress 2.0以降で使用可能です。

コアファイルのパス

wp-includes/comment.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	〇

この関数は特定のバージョンで非推奨または削除されたことはありません。