説明
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
関連
お勧め
Login rebuilderに「XML-RPC設定」を追加しました（2018年5月27日 更新）
公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。絵文字画像がPNGからSVGへ（2018年5月27日 更新）
WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。
4.4では投稿ページも専用テンプレートが適用できる（2018年5月27日 更新）
従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。
5.7の新機能：HTTPからHTTPSへの移行（2021年3月13日 更新）
先週は「WordPress 5.7 Beta 2（以降Beta 2）」が公開され、正式版リリースへ一歩進みました。WordPress 5.7の注目ポイントの1つに「HTTPからHTTPSへの移行」を手助けする機能があり、それに関連する機能を含んだhttps-detection.phpファイルとhttps-migration.phpが追加されていた。
wp_titleからwp_get_document_titleへ（2018年5月27日 更新）
先週、WordPress 4.4 beta1（以降4.4 beta1）が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。