comments_number

説明

void comments_number( [ string $zero = false [ , string $one = false [ , string $more = false [ , string = $deprecated = ''int | WP_Post $post_id = 0 ] ] ] ] )
投稿ページのコメント数を表示する。

パラメータ

  • $zero
    コメントが0件の場合に表示する内容を指定(省略時は'No Comments')。
  • $one
    コメントが1件の場合に表示する内容を指定(省略時は'1 Comment')。
  • $more
    コメントが2件以上の場合に表示する内容を指定(省略時は'n Comments'。※nは実際のコメント数)。
  • $deprecated
    未使用。[5.4.0]投稿IDまたは投稿情報を指定(省略時は0)

返り値

何もありません。

注意

[5.4.0]第4パラメータに対象の投稿IDまたは投稿情報が指定可能になった。従来、表示されるコメント件数は常にグローバル変数$idの投稿情報のコメント数だったが、5.4.0以降は第4パラメータが0の場合は同じ振る舞いとなる。

4.0.0でコメント数を取得する get_comments_number_textが追加され、フィルターもそちらに移行されている。


使用例

  • 投稿ページのコメント数を表示する。
    <?php comments_number( 'コメントはありません', 'コメント: 1件', 'コメント: %件' ); ?>
  • 変数$post_idが示す投稿ページのコメント数を表示する。
    <?php comments_number( 'コメントはありません', 'コメント: 1件', 'コメント: %件', $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:46



お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

メタボックスをクラシックエディターのみで表示する(2019年1月15日 更新)

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。