WordPress ページネーション講座

メインループでの paginate_links() の書き方

// メインループのページネーション
echo paginate_links(array(
          echo paginate_links(array(
            'base' => str_replace(999999999, '%#%', esc_url(get_pagenum_link(999999999))),
            'format' => '?paged=%#%',
            'current' => max(1, get_query_var('paged')),  // メインループではget_query_var()を使用
            'total' => $wp_query->max_num_pages,         // グローバル変数$wp_queryを参照              
            'prev_text' => '前へ',
            'next_text' => '次へ',
            'mid_size' => 2,
            'type' => 'list'
        ));

サブクエリ（カスタムクエリ）での paginate_links() の書き方

// ページ番号を取得して変数に保存
$paged = get_query_var('paged') ? get_query_var('paged') : 1;

// カスタムクエリの実行
$custom_query = new WP_Query(array(
    'post_type' => 'product',
    'posts_per_page' => 10,
    'paged' => $paged  // ここでページ番号を指定
));

// カスタムクエリのループと表示処理
// ...

// カスタムクエリのページネーション
echo paginate_links(array(
    'base' => str_replace(999999999, '%#%', esc_url(get_pagenum_link(999999999))),
    'format' => '?paged=%#%',
    'current' => max(1, $paged),                 // 保存した変数を使用
    'total' => $custom_query->max_num_pages,     // カスタムクエリのインスタンスを参照
    'prev_text' => '前へ',
    'next_text' => '次へ'
));

主な違いのポイント

1. 総ページ数の参照先:
   • メインループ: $wp_query->max_num_pages
   • サブクエリ: $custom_query->max_num_pages (インスタンス名は任意)
2. 現在のページ番号:
   • メインループ: get_query_var('paged')
   • サブクエリ: 事前に変数に保存した値 $paged
3. クエリの設定:
   • メインループ: WordPress が自動的に設定
   • サブクエリ: クエリ作成時に 'paged' => $paged のように明示的に指定

各パラメータの解説

テーマのCSSと連携しやすい

base
'base' => str_replace(999999999, '%#%', esc_url(get_pagenum_link(999999999))),

format
'format' => '?paged=%#%',

ページ番号のURLフォーマットを指定

?paged=%#% は通常のWordPressのクエリ文字列形式

%#% は実際のページ番号に置き換えられる

current
'current' => max(1, $paged),

現在のページ番号を指定

max(1, $paged) で負の値や0を防ぐ

最小値を1にすることで、最初のページを保証

total
'total' => $custom_query->max_num_pages,

総ページ数を指定

カスタムクエリの max_num_pages プロパティから取得

ページネーションの総ページ数を決定

prev_text と next_text
'prev_text' => '前へ', 'next_text' => '次へ',

前のページ、次のページのリンクテキストをカスタマイズ

日本語やアイコン、矢印などに変更可能

mid_size
'mid_size' => 2,

現在のページの前後に表示するページ番号の数

この例では現在のページの前後に2つのページ番号を表示

type
'type' => 'list'

出力形式を指定

'list' を使用すると <ul> と <li> タグでページネーションを生成

the_posts_pagination() 全引数一覧表