get_the_posts_pagination

説明

string get_the_posts_pagination( [ array $args = array() ] )
アーカイブページ向けのページ番号ナビゲーションを取得する。

パラメータ

  • $args
    パラメータを連想配列で指定(省略時はarray())。主なキーは次の通り。
    キー意味省略時の値
    'mid_size'現在のページ部の表示件数1
    'prev_text'前ページリンクの表記__( 'Previous' )
    'next_text'次ページリンクの表記__( 'Next' )
    'screen_reader_text'ナビゲーションの見出し(h2タグの中身)__( 'Posts navigation' )
    'class'[5.5.0]nav要素のclass属性値'pagination'

返り値

アーカイブページ向けのページ番号ナビゲーション(HTML)を返す。

注意

パラメータ$args paginate_links関数に引き継がれるが、$args['type']で'array'が指定された場合のみ'plain'に書き換えられている。

新テーマのTwenty Fifteenのスタイルでは、'prev_text'と'next_text'で指定した表記は非表示となっている。

単純に前ページおよび次ページのナビゲーションを取得する get_the_posts_navigation関数もある。


使用例

  • アーカイブページ向けのページ番号ナビゲーションを取得する。
    <?php $nav = get_the_posts_pagination(); ?>
  • アーカイブページ向けのページ番号ナビゲーションを'mid_size'を3として取得する。
    <?php $nav = get_the_posts_pagination( array( 'mid_size' => 3 ) ); ?>

フィルター

[6.1.0]ナビゲーションを生成する前に'the_posts_pagination_args'フィルターを呼び出す。パラメータ$argsには本関数が受け取った内容にデフォルト設定がマージされた内容が格納されている。
$args = apply_filters( 'the_posts_pagination_args', $args );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/link-template.php

最終更新 : 2022年11月06日 15:59



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。