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



お勧め

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

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

Somewhere search box:プラグイン作ってみました(2021年4月26日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

カスタムブロックを作っていると、ブロック自身の「サイズ」を指定するUIを持たせることがある。そんなときにちょっとモヤっとするのが、「マージン」や「パディング」の設定しているパネルのタイトルが「サイズ」なこと。この「サイズ」の原文は「Dimensions」であり、個人的にもう少しスッキリするワードに変更してみた。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)

日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。