概要
get_previous_post_link関数は、直前の投稿ページのリンクを取得するための関数です。この関数は、特定の投稿の前にある投稿へのリンクを生成し、ナビゲーションを簡単にするためによく利用されます。特にブログやニュースサイトなど、複数の投稿が関連している場合に役立ちます。この関数を使用する際によく使われる機能には、次が含まれます：
- 投稿ナビゲーションの実装
- 関連投稿の表示
- メタナビゲーションの作成
- SEO対策としての内部リンク強化
- 一連のストーリーや記事を連結する
- ユーザーエクスペリエンスの向上
- 過去のコンテンツへのアクセス促進
- 記事シリーズの一部としての位置付け
構文
get_previous_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy );
パラメータ
$format(string): リンクの書式。例えば<a href="%link">%title</a>のような形式。$link(string): リンクのテキスト。デフォルトは投稿のタイトル。$in_same_term(bool): true にすると、同じタクソノミーの投稿のみを取得。$excluded_terms(string|array): 除外するタクソノミーの用語。$taxonomy(string): チェックするタクソノミーの名前。
戻り値
- 成功時: 生成されたリンク
- 失敗時: null
関連する関数
使用可能なバージョン
get_previous_post_link関数は、WordPress 2.1.0以降で使用可能です。
コアファイルのパス
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 echo get_previous_post_link('%link', '前の投稿'); ?>
このコードは、直前の投稿へのリンクを生成し、「前の投稿」というテキストを表示します。
サンプル2: 同じタクソノミー内の投稿からリンクを取得
<?php echo get_previous_post_link('%link', '前の記事', true); ?>
このコードでは、同じタクソノミーに属する直前の投稿へのリンクを生成します。
サンプル3: カスタムリンク形式の使用
<?php echo get_previous_post_link('<strong>%link</strong>', '次の記事は次のとおり'); ?>
このコードは、直前の投稿へのリンクを強調表示し、「次の記事は次のとおり」という文言で表示します。
サンプル4: 特定のタクソノミーから投稿を除外
<?php echo get_previous_post_link('%link', '前の投稿', true, 'excluded-term'); ?>
このコードは、特定のタクソノミーの用語を除外して、前の投稿へのリンクを生成します。
サンプル5: カスタム投稿タイプでの使用
<?php echo get_previous_post_link('%link', '前のカスタム投稿', false, '', 'custom_post_type'); ?>
このコードでは、カスタム投稿タイプからの直前の投稿へのリンクを生成します。
このサンプルコードは著作権フリーのものです。