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' );

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

[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' ); ?>

フィルター

[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は本関数が受け取った同名パラメータとなる。[4.4.0]パラメータ$taxonomyにはタクソノミー名が($in_same_termがtrueの場合のみ有効)、$postには基準となる投稿情報が格納される。
$where = apply_filters( "get_{$adjacent}_post_where", $where, $in_same_term, $excluded_terms, $taxonomy, $post );
[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')。[4.4.0]パラメータ$postには基準となる投稿情報が格納される。[4.9.0]パラメータ$orderには本関数が受け取ったパラメータ$previousがtrueの場合は'DESC'が、falseの場合は'ASC'が格納される。
$sort = apply_filters( "get_{$adjacent}_post_sort", $sort, $post, $order );

アクション

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

ソースファイル

/wp-includes/link-template.php

最終更新 : 2017年11月16日 14:07



お勧め

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

5.3の新機能:サイト管理者のメールアドレスを定期的に確認する(2019年9月27日 更新)

WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。

5.3の新機能:JPEG画像の向きを自動調整(2019年10月17日 更新)

WordPress 5.3 Beta 1」に記載されていた「Automatic image rotation during upload」という見出し。画像ファイルに含まれるEXIF情報内の「向き」により、画像の向きを自動的に調整するというもの。どんな実装なのか気になったのでソースコードをざっくり眺めてみた。

投稿画面のウェジェットを2列にする(2013年4月17日 更新)

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。