get_comment_pages_count

(2.7.0以降)
get_comment_pages_count - コメントページ数を取得する

説明

int get_comment_pages_count( [ array $comments = null [ , int $per_page = null [ , bool $threaded = null ] ] ] )
コメントページ数を取得する。

パラメータ

  • $comments
    コメント情報を配列で指定(省略時はnull)。
  • $per_page
    1ページのコメント数を指定(省略時はnull)。
  • $threaded
    スレッドスタイルの場合はtrueを指定(省略時はnull)。

返り値

コメントページ数を返す。コメント情報がない場合は0を返す。

注意

パラメータ$commentsが省略されている場合は、現在の投稿ページのコメント情報($wp_query->comments)が適用される。

「ディスカッション設定」の「他のコメント設定」-「1ページあたり...」がチェックされておらず(get_option( 'page_comments' )の値が1以外)、表示可能なコメントがある場合、1を返す。

パラメータ$per_pageが省略されている場合、クエリー'comments_per_page'の値、1ページあたりのコメント数(get_option( 'comments_per_page' )の値)の順に適用される。

使用例

  • 現在の投稿ページのコメントページ数を取得する。
    <?php $cpage = get_comment_pages_count(); ?>
  • 取得済みのコメント情報からコメントページ数を取得する。
    <?php $cpage = get_comment_pages_count( $comments ); ?>
  • 取得済みのコメント情報から、1ページのコメント数を10、スレッドスタイルとしてコメントページ数を取得する。
    <?php $cpage = get_comment_pages_count( $comments, 10, true ); ?>

フィルター

直接実行するフィルターはありません。

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/comment.php

関連

お勧めコンテンツ

タイトルが一致する投稿を検索する(2014年2月20日 登録)

WordPressが提供する投稿ページの文字列検索機能の実現には、query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

全投稿を取得するのはnopaging=1でいい(2011年8月29日 登録)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?

管理者ページに文言を表示する(2012年4月19日 登録)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

パスとURL(2011年10月6日 登録)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

使っていないか確認しないとね!(2011年6月8日 登録)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.7.0現在、廃止予定となっている関数をまとめて紹介する。

最終更新日時 : 2015-12-16 14:34