the_posts_pagination()

関数の概要

the_posts_pagination() は、WordPressテーマ内で投稿のページナビゲーションリンクを表示するために使用される関数です。この関数は、複数ページにわたる投稿リストのナビゲーションリンクを生成し、ユーザーが次のページや前のページに簡単に移動できるようにします。主にアーカイブページやブログページで使用されます。paginate_links() 関数をより簡単に使用できる形でラップしたものです。

パラメータの説明

the_posts_pagination( $args )

  • $args (array|string)（省略可能）：ページナビゲーションリンクをカスタマイズするための引数の配列またはクエリ文字列。主な引数は以下の通りです：
  • mid_size (int)：現在のページ番号の前後に表示するページリンクの数。デフォルトは 1。
  • prev_text (string)：前のページへのリンクテキスト。デフォルトは __('Previous')。
  • next_text (string)：次のページへのリンクテキスト。デフォルトは __('Next')。
  • screen_reader_text (string)：スクリーンリーダー向けのテキスト。デフォルトは __( 'Posts navigation' )。
  • end_size (int)：最初と最後に表示するページリンクの数。デフォルトは 1。
  • type (string)：出力形式を指定します。デフォルトは array で、他に list があります。
  • show_all (bool)：全てのページリンクを表示するかどうか。デフォルトは false。

使用例

以下は、the_posts_pagination() 関数を使用してデフォルトの投稿ページナビゲーションリンクを表示する基本的な例です：

<?php the_posts_pagination(); ?>

カスタムテキストとページリンクの数を指定する例：

<?php the_posts_pagination( array(
    'mid_size'  => 2,
    'prev_text' => __('&laquo; Previous'),
    'next_text' => __('Next &raquo;'),
) ); ?>

関連する関数

  • paginate_links(): カスタムページナビゲーションリンクを生成するために使用される関数。
  • previous_posts_link(): 前の投稿ページへのリンクを表示するために使用されます。
  • next_posts_link(): 次の投稿ページへのリンクを表示するために使用されます。

ページナビゲーションのカスタマイズ

ページナビゲーションのスタイルや構造をカスタマイズするために、CSSクラスやカスタムHTMLを追加することができます。以下は、CSSクラスを追加してページナビゲーションをカスタマイズする例です：

<div class="custom-pagination">
    <?php the_posts_pagination( array(
        'mid_size'  => 2,
        'prev_text' => __('&laquo; Previous'),
        'next_text' => __('Next &raquo;'),
    ) ); ?>
</div>

前後の投稿ページリンクを一緒に表示する例

前の投稿ページリンクと次の投稿ページリンクを並べて表示する例です：

<div class="navigation">
    <?php the_posts_pagination( array(
        'prev_text' => __('&laquo; Previous'),
        'next_text' => __('Next &raquo;'),
    ) ); ?>
</div>

このようにすることで、ユーザーが投稿リストを前後に簡単に移動できるようになります。

スクリーンリーダーテキストのカスタマイズ

スクリーンリーダー向けのテキストをカスタマイズすることも可能です。以下は、スクリーンリーダーテキストを変更する例です：

<div class="navigation">
    <?php the_posts_pagination( array(
        'screen_reader_text' => 'Posts navigation',
    ) ); ?>
</div>

完全なカスタマイズ例

以下は、すべての主要な引数を使用してページナビゲーションを完全にカスタマイズする例です：

<div class="custom-pagination">
    <?php the_posts_pagination( array(
        'mid_size'  => 3,
        'end_size'  => 2,
        'prev_text' => __('&laquo; Older Posts'),
        'next_text' => __('Newer Posts &raquo;'),
        'show_all'  => false,
        'type'      => 'list',
        'screen_reader_text' => 'Posts navigation',
    ) ); ?>
</div>

このようにして、the_posts_pagination() 関数を使用することで、テーマのテンプレートファイル内で投稿のページナビゲーションリンクを簡単に表示することができます。これにより、ユーザーが異なる投稿ページにアクセスしやすくなり、サイトのナビゲーションが向上します。

スポンサーリンク