get_adjacent_post

(2.5.0以降)
get_adjacent_post - 現在の投稿記事に隣接する投稿記事を取得する

説明

object get_adjacent_post( [ bool $in_same_cat = false [ , mixed $excluded_categories = '' [ , bool $previous = true [ , string $taxonomy = 'category' ] ] ] ] )
現在の投稿記事に隣接する投稿記事を取得する。

パラメータ

  • $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')。

返り値

隣接する投稿情報のオブジェクトを返す。隣接する投稿情報がない場合はnullを返す。

注意

パラメータ$excluded_categoriesは、3.3で仕様変更され、文字列で複数のカテゴリーIDを指定する場合は' and 'で区切ることは非推奨になった。カンマ(,)で区切るか、配列で指定すること。
隣接する投稿記事は、投稿記事の投稿日時を起点に投稿日時でソート後、一番近い投稿記事が対象となる。
なおパラメータ$in_same_catをtrueにした場合、現在の投稿記事が属するカテゴリーのIDを$excluded_categoriesに含めても、そのカテゴリーを除外することはできないので、注意が必要である。具体的には、現在の投稿情報がカテゴリーIDが10と15のカテゴリーに属している場合、次のように指定してもIDが10のカテゴリーは対象から除外されない。
$prev = get_adjacent_post( true, '10' );
IDが15のカテゴリーのみを対象にする場合は、$in_same_catはfalseにし、$excluded_categoriesにはIDが15以外のすべてのカテゴリーIDを列挙したものを指定する必要がある(すべてのカテゴリーのIDが3、5、10、15の場合)。
$prev = get_adjacent_post( false, '3,5,10' );
なお、検索結果は検索条件に紐づいてキャッシュされ、次に検索条件が同じ場合はキャッシュから結果を返している。

使用例

  • 現在の投稿記事の前の投稿記事を取得する。
    <?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' ); ?>

フィルター

[2.5.0]本関数が受け取ったパラメータの解析後、"get_{$adjacent}_post_join"フィルターを呼び出す($adjacentは'previous'または'next')。パラメータ$joinはjoin句の内容が、$in_same_termおよび$excluded_termsは本関数が受け取った同名パラメータとなる。
$join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms );
[2.5.0]上記のフィルター処理後、"get_{$adjacent}_post_where"フィルターを呼び出す($adjacentは'previous'または'next')。パラメータ$joinはwhere句の内容が、$in_same_termおよび$excluded_termsは本関数が受け取った同名パラメータとなる。
$where = apply_filters( "get_{$adjacent}_post_where", $where, $in_same_term, $excluded_terms );
[2.5.0]上記のフィルター処理後、"get_{$adjacent}_post_sort"フィルターを呼び出す($adjacentは'previous'または'next')。パラメータ$sortはorder by句の内容として"ORDER BY p.post_date $order LIMIT 1"が格納されている($order$adjacentが'previous'の場合は'DESC'、'next'の場合は'ASC')。
$sort = apply_filters( "get_{$adjacent}_post_sort", $sort );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/link-template.php

関連

お勧めコンテンツ

決まった値を返すだけの関数群(2015年7月15日 登録)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

各種リンクを取得する関数一覧(2014年6月12日 登録)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

カスタムフィールドで並び替え(2013年8月9日 登録)

WordPressでは複数の投稿記事を取得する際、並び順の指定を省略すると投稿日時の降順になる。並び順は、投稿日時だけでなく、更新日時、投稿名、記事タイトル、コメント数のほか、カスタムフィールドも指定できる。

スマートフォン向けの振り分けを自前で行う(2011年11月2日 登録)

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。

投稿内容のid属性などを保存するための対策(2012年6月15日 登録)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

最終更新日時 : 2015-05-28 14:02