説明
パラメータ
- $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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。