get_the_posts_pagination()


WordPressのget_the_posts_pagination()関数は、投稿のページネーションを生成するために使用されます。この関数は、ページネーションのHTMLを返すため、カスタマイズが容易です。

構文

get_the_posts_pagination( array $args = array() );

引数の説明:

  • $args(array) — ページネーションの設定を配列で指定します。以下のキーを使用できます：
    • 'mid_size' — 現在のページの前後に表示するページ数。
    • 'prev_text' — 「前へ」リンクのテキスト。
    • 'next_text' — 「次へ」リンクのテキスト。
    • 'screen_reader_text' — スクリーンリーダー用のテキスト。
    • 'aria_label' — ページネーションのARIAラベル。
    • 'class' — ページネーションのCSSクラス。

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

この例では、基本的なページネーションを表示します。

<?php echo get_the_posts_pagination(); ?>

例2: 「前へ」と「次へ」のテキストを変更

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

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

例3: ページネーションの中央に表示するページ数を設定

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

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

例4: スクリーンリーダー用のテキストを追加

スクリーンリーダー用のテキストを追加します。

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

例5: ARIAラベルを設定

ページネーションのARIAラベルを設定します。

<?php echo get_the_posts_pagination( array( 'aria_label' => '投稿ページネーション' ) ); ?>

例6: CSSクラスを追加

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

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

例7: ページネーションの全体をカスタマイズ

複数の引数を組み合わせてページネーションをカスタマイズします。

<?php echo get_the_posts_pagination( array( 'mid_size' => 2, 'prev_text' => '前へ', 'next_text' => '次へ', 'screen_reader_text' => '投稿ナビゲーション', 'aria_label' => '投稿ページネーション', 'class' => 'custom-pagination' ) ); ?>

例8: ページネーションを条件付きで表示

投稿が複数ページにわたる場合のみページネーションを表示します。

<?php if ( get_the_posts_pagination() ) { echo get_the_posts_pagination(); } ?>

注意点

  • この関数は、投稿のページネーションのみを対象としています。カスタムクエリには適用されません。
  • ページネーションのスタイルは、テーマのCSSに依存します。必要に応じてCSSを調整してください。

関連機能：