概要
the_posts_pagination関数は、アーカイブページ向けのページ番号ナビゲーションを表示するために使用されるWordPressの関数です。この関数は、投稿のページネーションを生成し、ユーザーが前のページや次のページに移動しやすくします。特に、以下のような際に役立ちます。
- 投稿リストを分ける必要がある場合
- アーカイブページの閲覧を容易にするため
- カスタムクエリの結果をユーザーに見せるため
- カテゴリーやタグのアーカイブ表示時
- 検索結果のページネーションに最適
- 自作のテンプレートでページ番号を表示する際
- 特定の条件下での投稿表示制御に使用する場合
- ユーザビリティの向上を目指す場合
構文：
the_posts_pagination( $args );
パラメータ
mid_size(int) – 現在のページの前後に表示するページ番号の数。デフォルトは 2。prev_text(string) – 前のページを示すリンクのテキスト。デフォルトは ‘« Previous’。next_text(string) – 次のページを示すリンクのテキスト。デフォルトは ‘Next »’。screen_reader_text(string) – スクリーンリーダー用のテキスト。
戻り値
この関数は何も返さず、出力を直接行います。
関連する関数
使用可能なバージョン
the_posts_pagination関数は、WordPress 4.1.0以降で使用可能です。
コアファイルのパス
この関数は、WordPressのコアファイル wp-includes/pagination.php に実装されています。
サンプルコード
サンプル1：基本的なページネーション
このサンプルは、デフォルトの設定でページネーションを表示します。
if ( function_exists( 'the_posts_pagination' ) ) {
the_posts_pagination();
}
サンプル2：カスタマイズしたテキストを使用する
このサンプルでは、”Previous” と “Next” のテキストをカスタマイズしています。
the_posts_pagination( array(
'prev_text' => '前へ',
'next_text' => '次へ',
));
サンプル3：ページ番号の表示数を変更する
このサンプルは、現在のページの前後に表示するページ番号の数を変更しています。
the_posts_pagination( array(
'mid_size' => 3,
));
サンプル4：スクリーンリーダー用のテキストを追加する
このサンプルでは、スクリーンリーダー用のテキストを設定しています。
the_posts_pagination( array(
'screen_reader_text' => 'ページナビゲーション',
));
サンプル5：デフォルトのテキストを変更する
このサンプルでは、デフォルトの”Previous”と”Next”のテキストを変更し、ページ番号のスタイルもカスタマイズしています。
the_posts_pagination( array(
'prev_text' => '前の',
'next_text' => '次の',
'mid_size' => 1,
));
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
この関数が特定のWordPressバージョンで非推奨又は削除された場合、その情報はありません。