paginate_links()

WordPressのpaginate_links()関数は、ページネーションリンクを生成するために使用されます。この関数は、複数のページにわたるコンテンツをナビゲートするためのリンクを作成する際に役立ちます。

構文

paginate_links( array $args = array() );

引数の説明:

• $args(array) — ページネーションリンクの設定を指定するための配列。以下のキーを持つことができます。
• 'base'(string) — ページネーションリンクのベースURL。
• 'format'(string) — ページ番号のフォーマット。
• 'total'(int) — 総ページ数。
• 'current'(int) — 現在のページ番号。
• 'show_all'(bool) — すべてのページ番号を表示するかどうか。
• 'end_size'(int) — 最初と最後に表示するページ番号の数。
• 'mid_size'(int) — 現在のページの前後に表示するページ番号の数。
• 'prev_next'(bool) — 「前へ」と「次へ」のリンクを表示するかどうか。
• 'prev_text'(string) — 「前へ」リンクのテキスト。
• 'next_text'(string) — 「次へ」リンクのテキスト。

例1: 基本的なページネーションリンクの表示

この例では、基本的なページネーションリンクを表示します。

<?php echo paginate_links(); ?>

例2: カスタムベースURLを使用したページネーション

カスタムベースURLを使用してページネーションリンクを生成します。

<?php echo paginate_links( array( 'base' => str_replace( 999999999, '%#%', esc_url( get_pagenum_link( 999999999 ) ) ) ) ); ?>

例3: 総ページ数を指定したページネーション

総ページ数を指定してページネーションリンクを生成します。

<?php echo paginate_links( array( 'total' => 5 ) ); ?>

例4: 現在のページを指定したページネーション

現在のページ番号を指定してページネーションリンクを生成します。

<?php echo paginate_links( array( 'current' => 2 ) ); ?>

例5: 「前へ」と「次へ」のテキストを変更

「前へ」と「次へ」のテキストをカスタマイズします。

<?php echo paginate_links( array( 'prev_text' => '前のページ', 'next_text' => '次のページ' ) ); ?>

例6: すべてのページ番号を表示

すべてのページ番号を表示するように設定します。

<?php echo paginate_links( array( 'show_all' => true ) ); ?>

例7: ページ番号の表示範囲を調整

現在のページの前後に表示するページ番号の数を調整します。

<?php echo paginate_links( array( 'mid_size' => 2 ) ); ?>

注意点

• paginate_links()関数は、クエリがページネーションをサポートしている場合にのみ機能します。
• カスタムクエリを使用している場合、paginate_links()関数に適切な引数を渡す必要があります。