WEB制作のための情報サイト / unazuki Library
アーカイブページ（記事一覧ページ）にてページネーションを表示します。
the_posts_pagination($args);| 引数 | 必須/任意 | 引数に指定するもの |
|---|---|---|
| 第１引数 $args | 任意 | パラメーターを配列で指定利用できる主なパラメーターは下記の通り。 total 表示するページ数の上限（デフォルト：存在するページ分すべて）mid_size 現在のページ番号の両サイドにいくつのページ番号を表示するか（デフォルト：２）prev_text 前ページリンクのテキスト（デフォルト：前へ）next_text 次ページリンクのテキスト（デフォルト：次へ）初期値： []（空の配列）すべてのパラメーターはこちらを参照してください（英語） https://developer.wordpress.org/reference/functions/the_posts_pagination/ |
ページネーションを表示します。
このテンプレートタグはget_the_posts_pagination()のラッパー関数です。内部でget_the_posts_pagination()を実行しています。表示ではなく取得したい場合はget_the_posts_pagination()を利用します。
下記のコードをアーカイブページのテンプレートに記述すると、必要な場合にページネーションを表示します。下記の例では、前ページリンクと後ページリンクのテキストを引数で指定しています。
<?php
$args = [
'prev_text' => '«',
'next_text' => '»',
];
the_posts_pagination($args);
?>【引数とは】
テンプレートタグ（=関数）を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。
【引数について】
下記のコードは記事の一覧を表示し、ページネーションが必要な場合にそれを表示するコードです。WordPressループを抜けた後（while文の後）に記述します。
<?php if (have_posts()) : ?>
<ul class="cards">
<?php while (have_posts()): the_post(); ?>
<li class="cards__item card">
<a class="card__link" href="<?php the_permalink(); ?>">
<div class="card__data">
<div class="card__img">
<?php if (has_post_thumbnail()) : ?>
<?php the_post_thumbnail(); ?>
<?php endif; ?>
</div>
<div class="card__date"><?php echo get_the_date('') ?></div>
<div class="card__title"><?php the_title(); ?></div>
</div>
</a>
</li>
<?php endwhile; ?>
</ul>
<?php // ページング
$args = [
'prev_text' => '«',
'next_text' => '»',
];
the_posts_pagination($args);
?>
<?php endif; ?>※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。
