説明
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
関連
お勧め
Contact Form 7に確認フェーズを(2012年12月16日 更新)
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。投稿一覧に独自リンクを追加する(2013年10月16日 更新)
管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)
投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。投稿日の検索が自由自在に(2015年3月7日 更新)
WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。
プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)
バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。