paginate_comments_links()


WordPressの関数paginate_comments_links()は、投稿やページのコメントをページングするためのリンクを生成する機能を提供します。

構文

paginate_comments_links( array $args = array() );

引数の説明:

  • $args (array) — 設定オプションを含む配列。以下のキーが利用可能です:
    • base (string) — ページ番号を含むURLのベース。
    • format (string) — ページ番号のフォーマット。
    • total (int) — コメントページの総数。
    • current (int) — 現在のページ番号。
    • echo (bool) — 結果を出力するか返すか。デフォルトはtrue
    • add_fragment (string) — 各リンクのURLに追加されるフラグメント。

例1: コメントページリンクの基本的な表示

<?php paginate_comments_links(); ?>

例2: 現在のページを指定する

現在のコメントページを指定してリンクを生成します。

<?php paginate_comments_links( array( 'current' => get_query_var( 'cpage' ) ) ); ?>

例3: 総ページ数を指定する

コメントページの総数を指定してカスタマイズします。

<?php paginate_comments_links( array( 'total' => 5 ) ); ?>

例4: カスタムURLベースを設定

カスタムURL構造を使用します。

<?php paginate_comments_links( array( 'base' => '/comments/%#%' ) ); ?>

例5: ページ番号のフォーマットを変更する

ページ番号の表示フォーマットを変更します。

<?php paginate_comments_links( array( 'format' => '?page=%#%' ) ); ?>

注意事項

  • paginate_comments_links()は、現在のテーマがコメントをページングする必要がある場合にのみ使用してください。
  • 必要に応じてget_query_var( 'cpage' )を使用して現在のページを取得してください。
  • リンクが正しく表示されない場合は、パーマリンク設定を確認してください。

関連機能: