the_posts_pagination()


WordPressのthe_posts_pagination()関数は、投稿のページネーションを表示するために使用されます。この関数は、ページネーションのリンクを生成し、ユーザーが前後のページに移動できるようにします。

構文

the_posts_pagination( array $args = array() );

引数の説明:

  • $args(array) — ページネーションの設定を配列で指定します。デフォルト値は以下の通りです：
    • 'mid_size' — 現在のページの前後に表示するページ番号の数。デフォルトは1。
    • 'prev_text' — 「前へ」リンクのテキスト。デフォルトは「Previous」。
    • 'next_text' — 「次へ」リンクのテキスト。デフォルトは「Next」。
    • — スクリーンリーダー用のテキスト。デフォルトは「Posts navigation」。
    • — ページネーションのARIAラベル。デフォルトは「Posts」。
    • — ページネーションのラッパーに適用するCSSクラス。デフォルトは「pagination」。

例1: 基本的なページネーションの表示

この例では、デフォルト設定でページネーションを表示します。

<?php the_posts_pagination(); ?>

例2: 前後のリンクテキストの変更

「前へ」と「次へ」のリンクテキストをカスタマイズします。

<?php the_posts_pagination( array( 'prev_text' => '前のページ', 'next_text' => '次のページ' ) ); ?>

例3: ページ番号の表示数を増やす

現在のページの前後に表示するページ番号の数を3に設定します。

<?php the_posts_pagination( array( 'mid_size' => 3 ) ); ?>

例4: スクリーンリーダーテキストの変更

スクリーンリーダー用のテキストを「投稿ナビゲーション」に変更します。

<?php the_posts_pagination( array( 'screen_reader_text' => '投稿ナビゲーション' ) ); ?>

例5: CSSクラスの追加

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

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

例6: ARIAラベルの変更

ページネーションのARIAラベルを「ブログ投稿」に変更します。

<?php the_posts_pagination( array( 'aria_label' => 'ブログ投稿' ) ); ?>

注意点

  • the_posts_pagination()は、メインクエリに対してのみ動作します。カスタムクエリに対してページネーションを表示する場合は、paginate_links()を使用する必要があります。
  • ページネーションのスタイルは、テーマのCSSでカスタマイズする必要があります。

関連機能：