wp_link_pages

（1.2.0以降）
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

参考

Code Reference: wp_link_pages

お勧め

5.7の新機能：AJAXでパスワードを取得（2021年2月17日 更新）

日本時間の今朝「WordPress 5.7 Beta 3（以降Beta 3）」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。

5.4.1でパーマリンクの仕様が一部変更された件（2020年5月12日 更新）

先月末にリリースされたバージョン5.4.1のアップデートにより、一部のサイトで投稿ページが従来通りに表示されなくなる不具合が発生し、サポートサイトにレポートが上がりました。この件について、ちょっとモヤモヤしたので自分なりに考えてみました。

使っていないか確認しないとね！（2022年6月7日 更新）

2003年に誕生したWordPress。その歴史の中には、廃止予定（deprecated）となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.25.9.0現在、廃止予定となっている関数をまとめて紹介する。

HTML編集モードに定型文ボタンを追加する（2011年6月1日 更新）

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

テーブルの1列目をth要素にしてみる（2021年12月21日 更新）

標準の「テーブル」ブロックでは、tbody要素内のセルはすべてtd要素になっている。テーブルの1列目についてはth要素を使いたいケースがあり、「トグル」コントロールを使って切り替え可能にできないか調べてみた。