説明
mixed paginate_links( [ mixed $args = '' ] )
(アーカイブページ向けの)ページネートリンクを取得する。
パラメータ
- $argsページネートリンクのパラメータを連想配列または文字列で指定する(省略時は、'')。
キー名 意味 デフォルト値 base ベースURL('%_%'がページネート部分に置き換わる) '%_%' format ページネート部の書式('%#%'がページ番号に置き換わる) '?page=%#%' total 最大ページ数(2以上) 1 current 現在のページ番号 0 show_all 全件表示 false prev_next 「前へ」「次へ」のリンクの有無 true prev_text 「前へ」のテキスト __('« Previous') next_text 「次へ」のテキスト __('Next »') end_size 最終ページ部の表示件数(1以上) 1 mid_size 現在のページ部の表示件数(0以上) 2 type 出力形式('array'、'list'、その他) 'plain' add_args URLに追加するパラメータを連想配列で指定 false add_fragment add_argsパラメータ指定分の後に追加するパラメータ '' before_page_number [3.9.0]各ページ番号の前に追加するテキスト '' after_page_number [3.9.0]各ページ番号の後ろに追加するテキスト '' aria_current [4.9.0]現在のページを示すspan要素のaria_current属性値 'page'
返り値
'type'が'array'の場合は、各ページネートリンクを格納した配列を返す。'type'が'list'の場合は、UL、LIタグで囲まれたページネートリンクの文字列を返す。'type'が'array'および'list'以外の場合は、単純にページネートリンクが連結した文字列を返す。注意
ベースURL、ページ部について自由に設定できる汎用的な関数で、アーカイブページはもちろん検索結果ページでも応用できる(むしろこちらが本命かも)。'show_all'はデフォルトfalseで、ページ数が多い場合は途中が「…」になる(ドット表示)。'show_all'がtrueの場合にはドット表示されない。
使用例
- ベースURLが'http://localhost/category/news'で、ページ数を10、現在のページを5としてリンクを取得する。<?php $link = paginate_links( array( 'base'=>'http://localhost/category/news', 'total'=>10, 'current'=>5 ) ); ?>
- ベースURLが'http://localhost/category/news'で、ページ部を'/page/%#%'、ページ数を10、現在のページを5として、UL、LIタグ付きで取得する。<?php $link = paginate_links( array( 'base'=>'http://localhost/category/news', 'format'=>'/page/%#%', 'total'=>10, 'current'=>5, 'type'=>'list' ) ); ?>
フィルター
リンク先URLの生成時、'paginate_links'フィルターが呼び出される。パラメータ$linkにはリンク先URLが格納される。esc_url( apply_filters( 'paginate_links', $link ) )
アクション
実行するアクションはありません。ソースファイル
/wp-includes/general-template.php最終更新 : 2017年11月17日 09:07
関連
お勧め
自動生成される抜粋からテーブルブロックの内容を除外する(2022年4月6日 更新)
標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。
Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)
みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)
管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)
WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。
さくらのVPSでKUSANAGI#2(2018年5月27日 更新)
今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。