get_comments_number() の使い方|説明・引数・注意点

説明

get_comments_number() は、投稿のコメント数を取得する関数です。承認済みのコメントの数が返ります。

基本構文

get_comments_number( int|WP_Post $post = 0 ): string|int

引数

  • $post:投稿のIDまたはオブジェクト(省略すると、現在の投稿)

戻り値

コメントの数。

使い方(サンプル)

$count = (int) get_comments_number();
if ( $count > 0 ) {
	printf( esc_html__( 'コメント %d 件', 'my-theme' ), $count );
}

注意点

  • 承認待ちのコメントは、含まれません。
  • 出力ではなく、値を返します。

実務での使いどころ

  • 記事の一覧に、コメント数を表示するとき。
  • コメントがあるときだけ、コメント欄を表示するとき。

よくあるミスと対処

  • 戻り値を、数値として扱う前に、変換していない(文字列で返る場合がある)。
  • 承認待ちを含む数だと、考えている。
  • echo し忘れる。

NG例

get_comments_number(); // 返すだけで、出力されない

OK例

echo (int) get_comments_number();

使い分け早見表

関数 役割
get_comments_number() コメント数を、値として返す
comments_open() コメントが、受け付けられているか判定する
get_comments() コメントの一覧を取得する

関連項目

comments_open()、get_comments()、comments_template()

公式リファレンス:get_comments_number() | WordPress Developer Resources

コメント

タイトルとURLをコピーしました