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


お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

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

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

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。