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

関連

お勧めコンテンツ

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

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

ログインページのタイトルを変更してみる(2017年11月17日 登録)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 登録)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

スクリプトファイルのバージョンパラメータを変更する(2015年2月10日 登録)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

LevelとCapability(2011年4月14日 登録)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。

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