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



お勧め

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。