get_ancestors

（3.1.0以降）
get_ancestors - 先祖のIDをまとめて取得する

説明

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

関連

参考

Code Reference: get_ancestors

お勧め

oEmbed対応サイトを整理した（2020年4月6日 更新）

投稿記事にTwitterやYouTubeのURL（アドレス）を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み（機能）はoEmbedというもので、対応サイトは随時バージョンアップしている。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

絵文字画像がPNGからSVGへ（2018年5月27日 更新）

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

投稿記事でrubyタグを使えるようにする（前編）（2012年1月25日 更新）

rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。

個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。