• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get comments number

提供: WordPress Codex 日本語版
移動先: 案内検索

現在の(または指定された)投稿に対するコメント、トラックバックピンバックの合計数を取得します。 comments_number() と異なり、数値として合計数を返します。

使い方

<?php $my_var = get_comments_number( $post_id ); ?>

パラメータ

$post_ID
整数|オブジェクト) (オプション) 投稿の ID、または投稿オブジェクト(WP_Post)。
初期値: 0(現在の投稿)

戻り値

(整数) 
コメントの合計数。

用例

このコードは、get_comments_number を使って comments_number() のような表示を行います。

<?php
$num_comments = get_comments_number(); // get_comments_number は数値を返す

if ( comments_open() ) {
	if ( $num_comments == 0 ) {
		$comments = __('No Comments');
	} elseif ( $num_comments > 1 ) {
		$comments = $num_comments . __(' Comments');
	} else {
		$comments = __('1 Comment');
	}
	$write_comments = '<a href="' . get_comments_link() .'">'. $comments.'</a>';
} else {
	$write_comments =  __('Comments are off for this post.');
}
?>

参考

  • 合計数を返す前に apply_filters() を使って 'get_comments_number' フィルターフックを呼び出します。パラメータは、合計数と $post_ID です。
  • 投稿のオブジェクトを取得するために get_post() を使用します。

変更履歴

1.5.0 : 新規導入。

ソースファイル

get_comments_number()wp-includes/get_comment-template.php にあります。

コメント関数: cancel_comment_reply_link(), comment_author(), comment_author_email(), comment_author_email_link(), comment_author_IP(), comment_author_link(), comment_author_rss(), comment_author_url(), comment_author_url_link(), comment_class(), comment_date(), comment_excerpt(), comment_form_title(), comment_form(), comment_ID(), comment_id_fields() / en, comment_reply_link(), comment_text(), comment_text_rss(), comment_time(), comment_type(), comments_link, comments_number(), comments_open(), comments_popup_link(), comments_popup_script(), comments_rss_link(), get_avatar(), next_comments_link(), paginate_comments_links(), permalink_comments_rss(), previous_comments_link(), wp_list_comments()



関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Template Tags/get_comments_number最新版との差分