wp_link_pages

説明

string wp_link_pages( [ mixed $args = '' ] )
分割ページのリンクをパラメータ$argsのecho値が1ならば表示する。echo値が0ならばその文字列を取得する。

パラメータ

  • $args
    表示条件を指定する文字列(または連想配列)。文字列の場合はname=valueの形式で指定し、複数の条件はname1=value1&name2=value2のように'&'の後に続ける。主なキーワードは次の通り。
    キーワード省略時の値意味
    before'<p>Pages:'全ページリンクの前に連結する文字列
    after'</p>'全ページリンクの後に連結する文字列
    link_before''各ページリンクの前に連結する文字列
    link_after''各ページリンクの後に連結する文字列
    aria_current'page'[5.1.0]aria_current属性値として'page'、'step'、'location'、'date'、'time'、'true'、'false'のいずれかを指定
    next_or_number'number'リンクをページ番号で指定する場合は'number'を、それ以外の場合はnextpagelink値とpreviouspagelink値が有効になる
    nextpagelink'次のページへ'(next_or_number値が'number'以外の場合に有効)
    previouspagelink'前のページへ'(next_or_number値が'number'以外の場合に有効)
    pagelink'%'ページリンクの書式を指定。%を必ず含める必要があり、%が実際のページ番号に置き換わる(next_or_number値が'number'の場合に有効)
    more_file''
    echo1表示する場合は1、文字列として取得する場合は0

返り値

パラメータ$argsにecho値が0の場合は、リンクの文字列を返す。echo値が1(デフォルト)の場合は何も返さない。

注意

投稿情報が複数ページに分割されていない(<!--nextpage-->を含んでいない)場合は、何も表示されない。

使用例

  • 分割ページのリンクを表示する。
    <?php wp_link_pages( ); ?>

フィルター

[3.0.0]HTMLを生成する前に'wp_link_pages_args'フィルターを呼び出す。パラメータ$paramsには本関数が受け取ったパラメータ(連想配列)にデフォルト値をマージした内容が格納されている。
$r = apply_filters( 'wp_link_pages_args', $params );
[3.6.0]各リンク部品(a要素またはspan要素)を連結する前に'wp_link_pages_link'フィルターを呼び出す。パラメータ$linkにはリンク部品が、$iにはページ番号が格納されている。
$link = apply_filters( 'wp_link_pages_link', $link, $i );
[3.6.0]HTMLを生成した後で'wp_link_pages'フィルターを呼び出す。パラメータ$outputには生成したHTMLが、$argsには本関数が受け取った内容が格納されている。
$html = apply_filters( 'wp_link_pages', $output, $args );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/post-template.php

最終更新 : 2019年03月01日 16:05


お勧め

Posts filter multiselect:プラグイン作ってみました(2022年4月8日 更新)

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

古めのリビジョンを削除した時のメモ(2022年5月16日 更新)

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。