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


お勧め

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

同じ名前のメタ情報をまとめて削除する(2014年3月21日 更新)

WordPressには、投稿情報、コメント情報、ユーザ情報のそれぞれを拡張できるメタ情報の仕組みが用意されている。投稿情報のメタ情報は「カスタムフィールド」として投稿画面に用意されているので投稿者自身が随時操作できるほか、テーマやプラグインからの操作も容易である。今回の中身はそんなメタ情報の一括削除の話だ。