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



お勧め

5.3の新機能:日付とタイムゾーン(2019年10月2日 更新)

WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

PHPとMySQLのバージョンを確認(2013年9月11日 更新)

先日、WordPressで構築されたサイトについて最新版へのバージョンアップを依頼される。使用されていたWordPressはバージョン2.xということで、最新版へバージョンアップできるのか、PHPとMySQLのバージョンを確認することになった。

ACF(Advanced Custom Fields)向けにデータをインポートした時のメモ(2023年7月11日 更新)

ACFを採用するサイトにデータをインポートする際、ほとんどのことはwww.advancedcustomfields.comに記載されていたのだが、いくつかわからないことがあった。ここでは、その時に調べたことをメモしておく。

不要なプラグインを読み込まない(2023年6月2日 更新)

稼働中のサーバーにてバックグラウンドで何か処理しようとコマンドラインのプログラムを作る際、効率化や誤動作のリスクを考えると不要なプラグインはロードしないようにしたい。そんなわけで設定内容(データベース)は変更せず、特定のプラグインをロードしないようにできないか考えてみた。

Align widgets horizontally:プラグイン作ってみました(2024年2月28日 更新)

ほぼ毎日何度も見ているダッシュボードページ。自分好みに各ウィジェットの場所を配置しているものの、何かすっきりしない。そこでふと思ったのが、ウィジェットを横並びにできれば隣り合うウィジェットの並びがガタガタしなくなるのでは!?