wp_get_object_terms

説明

mixed wp_get_object_terms( mixed $object_ids, mixed $taxonomies [ , array $args = array() ] )
投稿記事などのタクソノミー情報を取得する。

パラメータ

  • $object_ids
    投稿記事などのオブジェクトID(数値)を指定。複数指定する場合はその配列を指定する。
  • $taxonomies
    'category'、'post_tag'などのタクソノミー名を指定。複数指定する場合はその配列を指定する。
  • $args
    取得するタクソノミー情報の条件を連想配列で指定(省略時はarray())。
    キーワード意味
    orderbyソート対象を示すcount、name、slug、term_group、term_order、noneなど(省略時は'name':名前)
    orderソート順を示すASCかDESC(省略時はDESC)
    fields取得する項目を示すall、ids、names、all_with_object_idなど(省略時はall)

返り値

マッチしたすべてのタクソノミー情報が格納された配列を返す。パラメータ$taxonomiesで指定された名前が無効な場合などのエラー時には WP_Errorのオブジェクトを返す。タクソノミー情報のプロパティは次の通り。
プロパティ名データ型意味
term_idintID
namestring名前
slugstringスラッグ
term_groupintグループID
term_taxonomy_idintタクソノミーID
taxonomystringタクソノミー名。カテゴリーの場合は'category'、タグの場合は'post_tag'となる
descriptionstring説明
parentint親カテゴリーID。親カテゴリーがない場合は0となる
countint投稿数
object_idintオブジェクトID(投稿IDなど)※'fields'で'all_with_object_id'指定時のみ

注意

この関数は、 wp_get_post_terms関数などから呼び出されるなど、同系列の関数の中では低レベルの関数となる。オブジェクトIDを複数指定できるほか、カテゴリー情報と投稿タグ情報を同時に取得できる。

使用例

  • 投稿IDが1の投稿タグ情報を取得する。
    <?php $terms = wp_get_object_terms( 1, 'post_tag' ); ?>
  • 投稿IDが1と2のカテゴリー情報と投稿タグ情報を取得する。
    <?php $terms = wp_get_object_terms( array( 1, 2 ), array( 'category', 'post_tag' ) ); ?>
  • 投稿IDが1と2のカテゴリー情報と投稿タグ情報をオブジェクトID付きで取得する。
    <?php $terms = wp_get_object_terms( array( 1, 2 ), array( 'category', 'post_tag' ), array( 'fields'=>'all_with_object_id' ) ); ?>

フィルター

[4.9.0]ターム情報を取得する前に'wp_get_object_terms_args'フィルターを呼び出す。パラメータ$argsには本関数が受け取った同名パラメータを解析した内容が、$object_idsには数値化されたタームIDの配列が、$taxonomiesにはタクソノミー名の配列が格納されている。
$args = apply_filters( 'wp_get_object_terms_args', $args, $object_ids, $taxonomies );
[4.2.0]ターム情報を取得した後に'get_object_terms'フィルターを呼び出す。パラメータ$termsには取得したターム情報の配列が、$object_idsには数値化されたタームIDの配列が、$taxonomiesにはタクソノミー名の配列が、$argsには解析済みの内容に'taxonomy'と'object_ids'キーを追加したものが格納されている。
$terms = apply_filters( 'get_object_terms', $terms, $object_ids, $taxonomies, $args );
[2.8.0]取得したターム情報を返す前に'wp_get_object_terms'フィルターを呼び出す。パラメータ$termsには取得したターム情報の配列が、$object_idsには','で連結したタームIDの文字列が、$taxonomiesには', 'で連結したタクソノミー名をさらに','で囲んだ文字列が、$argsには解析済みの内容に'taxonomy'と'object_ids'キーを追加したものが格納されている。
return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/taxonomy.php

最終更新 : 2022年01月05日 12:15



お勧め

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

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

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。