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



お勧め

テーブルブロックを定形に整える(2021年12月27日 更新)

ブロックエディターについて調べていると、「段落ブロックをもう少しカスタマイズした」で使ったRichTextShortcutとは別にショートカットキーを使うためのKeyboardShortcutsが見つかった。今回はこのKeyboardShortcutsを使ってテーブルブロックを定形に整える仕組みを考えてみた。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

スクリプトファイルのバージョンパラメータを変更する(2018年5月27日 更新)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2018年5月27日 更新)

ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。