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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。