get_comments_number_text:WordPress私的マニュアル

get_comments_number_text

(4.0.0以降)
get_comments_number_text - コメント数を示す文字列を取得する

説明

string get_comments_number_text( [ mixed $zero = false [ , mixed $one = false [ , mixed $more = false ] ] ] )

コメント数を示す文字列を取得する。

パラメータ

$zero
コメントがない場合のテキストを指定（省略時はfalse）。
$one
コメント数が1件の場合のテキストを指定（省略時はfalse）。
$more
コメント数が2件以上の場合のテキストを指定（省略時はfalse）。

返り値

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

注意

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

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

使用例

コメント数を示す文字列を取得する。
<?php $output = get_comments_number_text(); ?>

フィルター

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

return apply_filters( 'comments_number', $output, $number );

アクション

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

ソースファイル

/wp-includes/comment-template.php

参考

Code Reference: get_comments_number_text