説明
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' );
$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
関連
お勧め
ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日 更新）
今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。
the_date関数で投稿日を確実に表示する（2011年12月20日 更新）
投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。投稿内容に応じてwpautopを制御する（2013年8月13日 更新）
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。
xmlrpc.phpへのアクセスについてちょっと考えた（2018年5月27日 更新）
少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。
メディアライブラリに絞り込み用の「投稿タグ」を追加する（2014年6月24日 更新）
この記事は、先月投稿したコラム「メディア（attachment）を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。