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

最終更新 : 2017年11月30日 10:50



お勧め

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月14日 更新)

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

classic editorプラグインを試してみた(2018年12月10日 更新)

WordPress 5.0 beta1のリリースにあわせて旧エディター環境を実現できる「classic editor」(バージョン0.5.0)が公開された。自分が公開しているプラグインの一部が旧エディター環境に依存していることもあり、さっそく試してみた。WordPress 5.0正式リリースに合わせてclassic editorも1.0がリリースされたので、それについて追記しました。

コメントの「ウェブサイト」止めました(2014年4月15日 更新)

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。