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


お勧め

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

「姓」の後に「名」を(2013年11月6日 更新)

WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)

今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。