• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

テンプレートタグ/wp link pages

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「テンプレートタグ/wp link pages」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

ページ分割された投稿(<!--nextpage--> クイックタグ/en を 1 つ以上含む)についてページリンクを表示します。link_pages()(非推奨)とほぼ同様に動作しますが、引数をクエリ文字列(または配列)で指定する点が異なります。このタグはループ内で使用する必要があります。

使い方

<?php wp_link_pages( $args ); ?>

デフォルトの使い方

<?php
$defaults = array(
	'before'           => '<p>' . __( 'Pages:' ),
	'after'            => '</p>',
	'link_before'      => '',
	'link_after'       => '',
	'next_or_number'   => 'number',
	'separator'        => ' ',
	'nextpagelink'     => __( 'Next page' ),
	'previouspagelink' => __( 'Previous page' ),
	'pagelink'         => '%',
	'echo'             => 1
);
wp_link_pages( $defaults );
?>

パラメータ

before 
(文字列) リンクの前のテキスト。デフォルトは <p>Pages:
after 
(文字列) リンクの後のテキスト。デフォルトは</p>
link_before 
(文字列) リンクテキストの前のテキスト。デフォルトは空文字列。バージョン 2.7 以降。
link_after 
(文字列) リンクテキストの後のテキスト。デフォルトは空文字列。バージョン 2.7 以降。
next_or_number 
(文字列) ページ番号を使用するかどうかを指定する。有効な値は:
  • 'number' (デフォルト)
  • 'next' (WordPress 1.5 以降で有効)
separator 
(文字列) ページ番号の間のテキスト(適切な場合)。デフォルトはスペース 1 文字(改行可能)。(WordPress 3.6 以降で有効)
nextpagelink 
(文字列) 次のページへのリンクのテキスト。デフォルトは Next page。(WordPress 1.5 以降で有効)
previouspagelink 
(文字列) 前のページへのリンクのテキスト。デフォルトは Previous page。(WordPress 1.5 以降で有効)
pagelink 
(文字列) ページ番号のフォーマット。文字列内の % が番号に置き換えられる。例えば Page % は「Page 1」、「Page 2」などを生成する。デフォルトは '%'
echo 
(真偽値) HTML 出力する(true)か、変数として返す(false)か。デフォルトは true。有効な値は:
  • 1 (True) – デフォルト
  • 0 (False)

戻り値

(mixed) 
echotrue (デフォルト)にすると、NULL を返して内容(ページリンク)を表示します。echofalse にすると、HTML フォーマットされた内容を返します。

用例

デフォルトの使い方

デフォルトでは、ページリンクを段落(p)タグで囲い、Next pagePrevious page を使用し、ページ番号を Page 1, Page 2 のように表示します。

<?php wp_link_pages(); ?>

ページリンクを段落(p)タグで囲って表示します。

<?php wp_link_pages( 'before=<p>&after=</p>&next_or_number=number&pagelink=page %' ); ?>

ページリンクを DIV タグで囲い、CSS 参照用に <div id="page-links"> として表示します。

<?php wp_link_pages( 'before=<div id="page-links">&after=</div>' ); ?>

この小さなコードを content.php や single.php ファイルへ追加すると、その位置にページ送りを表示できます。

<?php wp_link_pages( array(
	'before'      => '<div class="page-links"><span class="page-links-title">' . __( 'Pages:', 'twentyfourteen' ) . '</span>',
	'after'       => '</div>',
	'link_before' => '<span>',
	'link_after'  => '</span>',
	) );
?>

変更履歴

  • 2.7 : パラメータに link_beforelink_after が追加されました。
  • 0.71 : 新規導入

ソースファイル

wp_link_pages()wp-includes/post-template.php にあります。

ページネーション: posts_nav_link(), next_posts_link(), previous_posts_link(), get_next_posts_link(), get_previous_posts_link(), paginate_links(), wp_link_pages(), next_post_link(), previous_post_link(), next_image_link(), previous_image_link(), the_posts_pagination(), get_the_posts_pagination()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_link_pages最新版との差分