説明
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
関連
お勧め
ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)
管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。
headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)
標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。<meta name="generator" content="WordPress 3.0.5" />
Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)
少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。
5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
投稿内容に応じてwpautopを制御する(2013年8月13日 更新)
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。