説明
array get_ancestors( [ int $object_id = 0 [ , string $object_type = '' [ , string $resource_type = '' ] ] ] )
先祖のIDをまとめて取得する。
パラメータ
- $object_idタームIDまたは投稿IDを指定（省略時は0）。
- $object_typeタクソノミー名または投稿タイプを指定（省略時は''）。
- $resource_type[4.1.0]'taxonomy'または'post_type'を指定（省略時は''）。
返り値
先祖のIDが格納された配列を返す。注意
タームまたは投稿情報の先祖を遡り、それらのIDをまとめて取得する。なお投稿情報のIDについては、本関数内でも使用されている get_post_ancestors関数があるので、基本的にはターム向けの関数といえるだろう。
パラメータ$resource_typeは4.1.0から追加されたもので、省略時はパラメータ$object_typeにより、'taxonomy'または'post_type'のいずれかが適用される。なお4.1.0時点では片方のフィルター呼び出しにて$resource_typeが記載されていないので要注意（4.1.1で修正済み）。
使用例
- $term_idの先祖のIDをまとめて取得する。<?php $ancestors = get_ancestors( $term_id ); ?>
- $term_idの先祖のIDをまとめて取得する。<?php $ancestors = get_ancestors( $cat_id, 'category' ); ?>
フィルター
[3.1.0]先祖のIDが格納された配列を返す前に'get_ancestors'フィルターを呼び出す。パラメータ$ancestorsには先祖のIDが格納された配列が、その他のパラメータは本関数が受け取った内容が格納される。return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/taxonomy.php最終更新 : 2018年05月27日 10:46
関連
お勧め
5.5で非推奨になる関数名について（2020年8月12日 更新）
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2（以降Beta 2）」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
meta_compare_key使ってみた（2019年3月19日 更新）
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。
プラグインの設定ページもレスポンシブ対応（2014年6月3日 更新）
レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。
初期化に関連するアクションのおさらい（2013年11月27日 更新）
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）
query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？