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



お勧め

「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

get_postsとquery_postsを使い分け(2018年5月27日 更新)

get_posts query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。