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



お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。