概要
get_the_posts_pagination関数は、アーカイブページ向けのページ番号ナビゲーションを取得するために使用されます。この関数は、特に複数ページにわたる投稿リストを表示する際に便利で、ユーザーが異なるページ間をナビゲートするのを容易にします。一般的に以下のような機能の実装で使われます。
- カテゴリーアーカイブのページネーション
- タグアーカイブのページネーション
- 日付アーカイブのページネーション
- カスタム投稿タイプの一覧表示
- 検索結果のページネーション
- 投稿者アーカイブのページネーション
- 特定の投稿タイプの投稿リストのページネーション
- メインクエリのページネーション
構文
get_the_posts_pagination( $args );
パラメータ
$args(配列): ページナビゲーションのオプションを設定するための引数の配列です。例えば、'mid_size'（表示するページ番号の数）や'prev_text'（前のページのテキスト）などがあります。
戻り値
- (文字列): HTML形式のページネーションを含む文字列を返します。
関連する関数
ワードプレスバージョン
- この関数は、WordPress 4.1以降で使用可能です。
コアファイルのパス
wp-includes/query.php
例コード1: 基本的なページネーション
このサンプルコードは、デフォルトの引数を使用してページネーションを表示します。
if ( have_posts() ) :
while ( have_posts() ) : the_post();
// 投稿内容を表示
endwhile;
// ページネーションを表示
echo get_the_posts_pagination();
endif;
例コード2: カスタム引数を使ったページネーション
カスタム引数を使用してページネーションの前と次のテキストを変更します。
echo get_the_posts_pagination( array(
'mid_size' => 2,
'prev_text' => __('« 前へ', 'textdomain'),
'next_text' => __('次へ »', 'textdomain'),
) );
例コード3: 特定のクエリを使用したページネーション
WP_Queryを使用して特定の投稿を取得し、そのページネーションを表示します。
$paged = ( get_query_var('paged') ) ? get_query_var('paged') : 1;
$args = array(
'post_type' => 'post',
'paged' => $paged,
);
$query = new WP_Query( $args );
if ( $query->have_posts() ) :
while ( $query->have_posts() ) : $query->the_post();
// 投稿内容を表示
endwhile;
echo get_the_posts_pagination();
endif;
wp_reset_postdata();
例コード4: 複数のページサイズを指定する
ページサイズを指定して、ページネーションの見た目をカスタマイズする例です。
echo get_the_posts_pagination( array(
'screen_reader_text' => ' ',
'mid_size' => 3,
'end_size' => 1,
) );
例コード5: WP_Queryの使用例
Postタイプが’page’のアーカイブのページネーションを表示する例です。
$paged = ( get_query_var('paged') ) ? get_query_var('paged') : 1;
$args = array(
'post_type' => 'page',
'paged' => $paged,
);
$query = new WP_Query( $args );
if ( $query->have_posts() ) :
while ( $query->have_posts() ) : $query->the_post();
// 投稿内容を表示
endwhile;
echo get_the_posts_pagination();
endif;
wp_reset_postdata();
この関数のアクションでの使用可能性
| アクション | 使用可能 |
|---|---|
| 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 |
非推奨または削除されたバージョン
該当するバージョンはありません。この関数は現在のところ非推奨または削除されていません。