概要
get_adjacent_post 関数は、現在の投稿記事に隣接する投稿記事を取得するために使用されます。主に、ブログやニュースサイトなどで前後の関連記事へのリンクを提供する際に利用されます。以下は、この関数がよく使われるシナリオの例です：
- 投稿の次の記事へのリンクを表示する。
- 投稿の前の記事へのリンクを表示する。
- パラメータを使用して特定のカテゴリー内の隣接記事を取得する。
- タグによって隣接する記事を取得し、人気のあるコンテンツを促進する。
- カスタム投稿タイプに対して隣接記事を取得する。
- 隣接する投稿記事をサイドバーウィジェットで表示する。
- ユーザーがナビゲートしやすいように、序列を表示するためのカスタムテンプレートで使用する。
- SEOのために、関連するページを簡単にリンクできるようにする。
構文
get_adjacent_post( $in_same_term, $excluded_terms, $previous, $post_type );
パラメータ
$in_same_term: (bool) ターム（カテゴリーやタグ）内での取得を指定する。$excluded_terms: (int|array) 除外するタームのIDまたは配列。$previous: (bool) 前の記事を取得する場合はtrue、次の記事の場合はfalse。$post_type: (string|array) 投稿タイプ、指定がない場合は全ての投稿タイプが対象。
戻り値
WP_Post オブジェクトまたは隣接する投稿が存在しない場合は null。
関連する関数
使用可能なバージョン
get_adjacent_post 関数は、WordPress 2.0.0 以降で使用可能です。
コアファイルのパス
wp-includes/post.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 |
この関数は、特定のワードプレスバージョンで非推奨または削除されていません。