the_comments_pagination()


WordPressの関数the_comments_pagination()は、コメントのページ分割リンクを表示するために使用されます。

構文

the_comments_pagination( array $args = array() );

引数の説明:

  • $args (array) — 配列形式でカスタマイズオプションを指定します。主なキーは以下の通りです。
    • prev_text (string) — 前のページへのリンクテキスト。デフォルトは「« 前のページ」。
    • next_text (string) — 次のページへのリンクテキスト。デフォルトは「次のページ »」。
    • before_page_number (string) — ページ番号の前に表示するテキスト。
    • after_page_number (string) — ページ番号の後に表示するテキスト。
    • mid_size (int) — 現在のページの前後に表示するページ番号の数。
    • end_size (int) — 最初と最後に表示するページ番号の数。

例 1: デフォルト設定での使用

コメントのページ分割リンクをデフォルト設定で表示します。

<?php the_comments_pagination(); ?>

例 2: テキストをカスタマイズ

前後のリンクテキストをカスタマイズします。

<?php
the_comments_pagination( array(
    'prev_text' => '前へ',
    'next_text' => '次へ',
) );
?>

例 3: ページ番号に装飾を追加

ページ番号の前後に装飾文字列を追加します。

<?php
the_comments_pagination( array(
    'before_page_number' => '<span class="page-num">',
    'after_page_number'  => '</span>',
) );
?>

例 4: ページサイズの設定

ページ番号の表示範囲をカスタマイズします。

<?php
the_comments_pagination( array(
    'mid_size' => 2,
    'end_size' => 1,
) );
?>

例 5: カスタムCSSクラスの追加

ページネーションにカスタムCSSクラスを追加します。

<?php
the_comments_pagination( array(
    'class' => 'custom-pagination-class',
) );
?>

注意点

  • コメントページが1ページしかない場合、出力は表示されません。

関連機能：