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

最終更新 : 2015年12月16日 14:34



お勧め

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。