get_adjacent_post

パラメータ

• $in_same_cat$in_same_term
  現在の投稿情報と同じタクソノミー（[3.8.0]より前のバージョンはカテゴリー、[3.8.0]以降のバージョンは$taxonomyで指定されたタクソノミー）で絞り込む場合はtrue、限定しない場合はfalse（省略時はfalse）。
• $excluded_categories$excluded_terms
  除外するターム（[3.8.0]より前のバージョンはカテゴリー、[3.8.0]以降のバージョンは$taxonomyで指定されたタクソノミー）のIDを指定（省略時は''）。複数のカテゴリーを除外する場合は、'1 and 3'のように' and 'で連結して指定する’1,3’のようにカンマで連結した文字列を指定するか、配列で指定する。
• $previous
  前の投稿情報を調べる場合はtrueを、次の投稿情報を調べる場合はfalseを指定（省略時はtrue）。
• $taxonomy
  [3.8.0]$in_same_termがtrueの場合に同一判定するタクソノミー名を指定（省略時は'category'）。

返り値

注意

パラメータ$excluded_categoriesは、3.3で仕様変更され、文字列で複数のカテゴリーIDを指定する場合は' and 'で区切ることは非推奨になった。カンマ（,）で区切るか、配列で指定すること。
隣接する投稿記事は、投稿記事の投稿日時を起点に投稿日時でソート後、一番近い投稿記事が対象となる。
なおパラメータ$in_same_catをtrueにした場合、現在の投稿記事が属するカテゴリーのIDを$excluded_categoriesに含めても、そのカテゴリーを除外することはできないので、注意が必要である。具体的には、現在の投稿情報がカテゴリーIDが10と15のカテゴリーに属している場合、次のように指定してもIDが10のカテゴリーは対象から除外されない。

$prev = get_adjacent_post( true, '10' );

$prev = get_adjacent_post( false, '3,5,10' );

なお、検索結果は検索条件に紐づいてキャッシュされ、次に検索条件が同じ場合はキャッシュから結果を返している。

[4.4.0]"get_{$adjacent}_post_where"フィルターにパラメータ$taxonomyおよび$postが、"get_{$adjacent}_post_sort"フィルターにパラメータ$postが追加された。

[4.9.0]"get_{$adjacent}_post_sort"フィルターにパラメータ$orderが追加された。

使用例

• 現在の投稿記事の前の投稿記事を取得する。
  <?php $prev = get_adjacent_post(); ?>
• 現在の投稿記事と同じカテゴリーの次の投稿記事を取得する。
  <?php $next = get_adjacent_post( true, '', false ); ?>
• 現在の投稿記事と次の投稿記事を取得する。
  <?php $next = get_adjacent_post( false, '', false ); ?>
• カテゴリーIDが10と15のカテゴリーを除外して現在の投稿記事と次の投稿記事を取得する。
  <?php $next = get_adjacent_post( false, '10,15', false ); ?>
• 現在の投稿記事と同じタグの次の投稿記事を取得する。
  <?php $next = get_adjacent_post( true, '', false, '', 'post_tag' ); ?>

フィルター

アクション

ソースファイル