概要
previous_post_link 関数は、特定の投稿において「1つ前のリンクを表示する」機能を提供します。この関数は主にブログや記事ページで前の投稿へのナビゲーションリンクを簡単に作成する際に使用されます。これにより、ユーザーはブログの過去のコンテンツを容易に辿ることができ、ページビューの向上にも寄与します。
この関数は以下のような場面で非常に有用です。
- 投稿ページでナビゲーションを強化する
- 時系列的なコンテンツを持つサイトでのユーザー体験の向上
- セクションごとに関連する投稿をまとめる
- シリーズ記事の前後関係を示す
- 定期的な更新を行っているサイトの利用促進
- トピックに関連する投稿を簡単に見せる
- ユーザーのサイト内回遊率を向上させる
- 情報整理や整頓のための手助けをする
構文
previous_post_link( string $format = '%link', string $in_same_term = false, bool $excluded_terms = '' );
パラメータ
$format(string) : リンクのフォーマット。デフォルトは%linkで、他にもタイトルのプレースホルダなどが指定可能です。$in_same_term(bool) : 同じターム内の投稿から前の投稿を取得するかどうかを指定します。デフォルトはfalseです。$excluded_terms(string) : 除外するタームのスラッグ（カンマ区切りの場合もある）。
戻り値
この関数はリンクを生成して出力しますが、戻り値はありません。
関連する関数
利用可能なバージョン
- これはすべての WordPress バージョンで使用可能です。
コアファイルパス
/wp-includes/link-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 previous_post_link('%link', '前の投稿'); ?>
このコードは、タイトルが「前の投稿」となっている前の投稿へのリンクを表示します。
サンプル2: フォーマット付きリンク
<?php previous_post_link('%link', '<< %title', true); ?>
このコードでは、前の投稿のタイトルをリンクの中に挿入し、「<<」という文字列を前に追加して表示します。
サンプル3: タームを除外してリンク表示
<?php previous_post_link('%link', '前の投稿', true, 'カテゴリ'); ?>
このコードは「カテゴリ」のタームに基づいて前の投稿を取得し、そのリンクを表示します。
サンプル4: 投稿日時でソートされたリンク表示
<?php previous_post_link('%link', '前の投稿へ', false); ?>
このコードは、投稿の日時に基づいた前の投稿へのリンクを表示します。
サンプル5: クエリパラメータを追加する
<?php previous_post_link('%link?custom_param=value', '前の投稿に移動'); ?>
このコードは前の投稿のリンクにクエリパラメータを追加し、そのリンクに「前の投稿に移動」というテキストを表示します。