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



お勧め

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

5.7の新機能:HTTPからHTTPSへの移行(2021年3月13日 更新)

先週は「WordPress 5.7 Beta 2(以降Beta 2)」が公開され、正式版リリースへ一歩進みました。WordPress 5.7の注目ポイントの1つに「HTTPからHTTPSへの移行」を手助けする機能があり、それに関連する機能を含んだhttps-detection.phpファイルとhttps-migration.phpが追加されていた。

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

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