ワードプレスのwp_link_pages関数の使用方法・解説

概要

wp_link_pages関数は、投稿やページが分割されている際に、各ページへのリンクを表示するために使用されます。この関数は特に、以下のような機能を実装する際によく使われます。

1. 分割された投稿内容のナビゲーション
2. 複数ページにまたがるマニュアルやガイドの作成
3. サイトのユーザーエクスペリエンス向上
4. レシピや商品レビューの詳細情報表示
5. 複雑なストーリーテリングの実現
6. 読者の注意を引くための連載記事
7. トピックごとに分割された技術的なコンテンツ
8. インタビュー記事の整理

構文

wp_link_pages( array $args = array() )

パラメータ

wp_link_pages関数は、以下のようなパラメータを受け取ります。

• before: リストの開始タグ（デフォルトは空）
• after: リストの終了タグ（デフォルトは空）
• link_before: 各リンクの前に追加するHTML（デフォルトは空）
• link_after: 各リンクの後に追加するHTML（デフォルトは空）
• next_or_number: 「次へ」またはページ番号リンクを表示するかどうか（デフォルトは「number」）
• nextpagelink: 「次へ」リンクのテキスト（デフォルトは「次へ」）
• previouspagelink: 「前へ」リンクのテキスト（デフォルトは「前へ」）
• pagelink: ページリンクのラベル（デフォルトは「%」）

戻り値

特に戻り値はありませんが、HTMLとして分割ページのリンクを表示します。

関連する関数

• wp_link_pages
• the_content

使用可能なバージョン

wp_link_pages関数は、WordPressの全バージョンで利用可能です。

コアファイルのパス

この関数は、次のコアファイルに含まれています。
wp-includes/post-template.php

この関数のアクションでの使用可能性

アクション名	使用の有無
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

サンプルコード

サンプルコード 1: 基本的な使用方法

<?php
$post_content = 'ページ1の内容。<!--nextpage-->ページ2の内容。<!--nextpage-->ページ3の内容。';
the_content($post_content);
wp_link_pages();
?>

このコードでは、the_content関数で分割された投稿内容を表示し、wp_link_pages関数を使用してページリンクを作成します。

サンプルコード 2: カスタムリンクテキストを使用する

<?php
wp_link_pages(array(
    'before' => '<ul>',
    'after' => '</ul>',
    'link_before' => '<li>',
    'link_after' => '</li>',
    'nextpagelink' => '次のページ',
    'previouspagelink' => '前のページ',
));
?>

このコードでは、wp_link_pages関数にカスタムHTMLを追加し、ページリンクに異なるテキストを指定します。

サンプルコード 3: ページ番号を表示する

<?php
wp_link_pages(array(
    'next_or_number' => 'number',
    'pagelink' => '%'
));
?>

このサンプルでは、ページ番号を表示するように設定し、各ページのリンクにそのページ番号を使用しています。

サンプルコード 4: CSSクラスを追加する

<?php
wp_link_pages(array(
    'before' => '<div class="pagination">',
    'after' => '</div>',
    'link_before' => '<span>',
    'link_after' => '</span>'
));
?>

このコードでは、ページリンクにCSSクラスを追加して、スタイルを適用できるようにしています。

サンプルコード 5: 複数ページ記事の表示

<?php
if (is_single()) {
    the_content();
    wp_link_pages(array(
        'before' => '<div class="page-links">',
        'after' => '</div>',
        'link_before' => '<span>',
        'link_after' => '</span>'
    ));
}
?>

このコードは、投稿が単一ページであればthe_contentを表示し、その後にwp_link_pagesを使用してページリンクを表示します。