comments_number

（0.71以降）
comments_number - 投稿ページのコメント数を表示する

説明

void comments_number( [ string $zero = false [ , string $one = false [ , string $more = false [ , string = $deprecated = ''int | WP_Post $post_id = 0 ] ] ] ] )
投稿ページのコメント数を表示する。

パラメータ

  • $zero
    コメントが0件の場合に表示する内容を指定（省略時は'No Comments'）。
  • $one
    コメントが1件の場合に表示する内容を指定（省略時は'1 Comment'）。
  • $more
    コメントが2件以上の場合に表示する内容を指定（省略時は'n Comments'。※nは実際のコメント数）。
  • $deprecated
    未使用。[5.4.0]投稿IDまたは投稿情報を指定（省略時は0）

返り値

何もありません。

注意

[5.4.0]第4パラメータに対象の投稿IDまたは投稿情報が指定可能になった。従来、表示されるコメント件数は常にグローバル変数$idの投稿情報のコメント数だったが、5.4.0以降は第4パラメータが0の場合は同じ振る舞いとなる。

4.0.0でコメント数を取得する get_comments_number_textが追加され、フィルターもそちらに移行されている。

使用例

  • 投稿ページのコメント数を表示する。
    <?php comments_number( 'コメントはありません', 'コメント: 1件', 'コメント: %件' ); ?>
  • 変数$post_idが示す投稿ページのコメント数を表示する。
    <?php comments_number( 'コメントはありません', 'コメント: 1件', 'コメント: %件', $post_id ); ?>

フィルター

[1.5.0]コメント数を示す文字列を返す直前に'comments_number'フィルターを呼び出す。パラメータ$outputはコメント数を示す文字列、$numberはコメント数となる。
return apply_filters( 'comments_number', $output, $number );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/comment-template.php

最終更新 : 2020年04月03日 13:46

関連

参考

Code Reference: comments_number

お勧め

任意の名前でエラーログファイルを指定する（2019年2月15日 更新）

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink：プラグイン作ってみました（2021年4月20日 更新）

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する（2018年5月27日 更新）

テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。