get_ancestors:WordPress私的マニュアル

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

参考

Code Reference: get_ancestors

get_ancestors

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

お勧めコンテンツ