get_comments_number_text

説明

string get_comments_number_text( [ mixed $zero = false [ , mixed $one = false [ , mixed $more = false [ , int | WP_Post $post_id = 0 ] ] ] ] )
コメント数を示す文字列を取得する。

パラメータ

  • $zero
    コメントがない場合のテキストを指定(省略時はfalse)。
  • $one
    コメント数が1件の場合のテキストを指定(省略時はfalse)。
  • $more
    コメント数が2件以上の場合のテキストを指定(省略時はfalse)。
  • $post_id
    [5.4.0]投稿IDまたは投稿情報を指定(省略時は0)

返り値

コメント数を示す国際化対応済みの文字列を返す。

注意

[5.4.0]パラメータ$post_idが追加され、それは get_comments_number関数へ引き継がれる。

パラメータ$zeroがfalseの場合は、'No Comments'の翻訳テキストが適用される。
パラメータ$oneがfalseの場合は、'1 Comment'の翻訳テキストが適用される。
パラメータ$moreには'%'を含めることができる。'%'は number_format_i18n関数によって書式化されたコメント数に置き換えられる。

フィルターバージョンが1.5.0になっているのは、コメント数を表示する comments_number関数のフィルターを継承しているためである。


使用例

  • コメント数を示す文字列を取得する。
    <?php $output = get_comments_number_text(); ?>
  • 変数$post_idが示す投稿ページのコメント数を示す文字列を取得する。
    <?php $output = get_comments_number_text( false, false, false, $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:55



お勧め

パスとURL(2011年10月6日 更新)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。