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

関連

お勧めコンテンツ

初期化に関連するアクションのおさらい(2012年8月7日 登録)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 登録)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

Slightly troublesome permalink:プラグイン作ってみました(2012年2月9日 登録)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

さくらのVPSでKUSANAGI#2(2017年5月16日 登録)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

Login rebuilder 2.3.0の新機能を紹介(2017年8月31日 登録)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

最終更新日時 : 2015-02-23 11:40