wp_link_pages()


WordPressのwp_link_pages()関数は、投稿や固定ページを分割表示する際に使用されます。この関数を使用することで、複数のページにまたがるコンテンツを管理しやすくなります。

構文

wp_link_pages( array $args = array() );

引数の説明:

  • $args (array) — 配列として設定可能なオプションのリスト。
  • before (string) — ページリンクの前に表示するHTML文字列。
  • after (string) — ページリンクの後に表示するHTML文字列。
  • link_before (string) — 各リンクの前に表示する文字列。
  • link_after (string) — 各リンクの後に表示する文字列。
  • next_or_number (string) — ‘next’または’number’のいずれかを指定（デフォルトは’number’）。
  • separator (string) — リンク間のセパレーター。
  • nextpagelink (string) — 次ページへのリンクテキスト。
  • previouspagelink (string) — 前ページへのリンクテキスト。
  • echo (bool) — 結果を出力するかどうか（デフォルトはtrue）。

例1: 基本的な使用例

投稿や固定ページを分割表示するための最も簡単な例です。

<?php wp_link_pages(); ?>

例2: HTMLラッパーを追加

リンクを<div>タグで囲む例です。

<?php wp_link_pages( array( 'before' => '<div class="page-links">', 'after' => '</div>' ) ); ?>

例3: 次ページと前ページのリンクテキストを設定

カスタムテキストを使用してリンクを表示します。

<?php wp_link_pages( array( 'nextpagelink' => '次へ', 'previouspagelink' => '前へ' ) ); ?>

例4: 数字のリンクをカスタマイズ

リンク間にセパレーターを追加する例です。

<?php wp_link_pages( array( 'separator' => ' | ' ) ); ?>

例5: 出力結果を変数に格納

結果を出力せず、変数に格納してカスタマイズする例です。

<?php
$page_links = wp_link_pages( array( 'echo' => false ) );
echo '<div class="custom-pagination">' . $page_links . '</div>';
?>

注意事項

wp_link_pages()関数は、分割された投稿やページ内でのみ機能します。また、<!--nextpage-->タグを投稿内で使用する必要があります。

関連機能：