• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/wp get object terms

提供: WordPress Codex 日本語版
移動先: 案内検索

指定されたオブジェクト(複数でもよい)に付いている、指定されたタクソノミー(カスタム分類)のタームを取得します。

使い方

<?php wp_get_object_terms( $object_ids, $taxonomies, $args ); ?>

パラメータ

$object_ids
文字列|配列) (必須) タームを取得するオブジェクトの ID 。
初期値: なし
$taxonomies
文字列|配列) (必須) タームを取得するタクソノミー。例: 'category', 'post_tag', 'taxonomy slug'
初期値: なし
$args
配列|文字列) (オプション) 戻り値の種類を指定。
初期値: array()

デフォルトの引数

$args = array( 'orderby' => 'name', 'order' => 'ASC', 'fields' => 'all' );

引数のオプション

以下の情報を $args パラメータに指定できます。指定する場合は文字列形式または配列とします。

order 
(文字列)
  • ASC - デフォルト:昇順にソートする。
  • DESC :降順にソートする。
orderby 
(文字列)
  • name - デフォルト:名前でソートする。
  • count :タームの使用回数でソートする。
  • slug :スラッグでソートする。
  • term_group :タームのグループでソートする。
  • term_order :タームの順序でソートする。
  • term_id :タームの ID でソートする。
  • none :ソートしない。
fields 
(文字列)
  • all - デフォルト:マッチするすべてのタームのオブジェクトを返す。
  • ids :タームの ID を返す。
  • names :タームの名前を返す。
  • slugs :タームのスラッグを返す。
  • all_with_object_id :マッチするすべてのタームのオブジェクトと、そのオブジェクトの ID を返す。
  • tt_ids :ターム・タクソノミー ID を返す。

参考: 引数は wp_parse_args() 関数が使用する形式で与えます。

戻り値

(配列|WP_Error) 
指定された条件に合ったタームのオブジェクト等。タームが見つからない場合は空の配列。もし $taxonomy が存在しなければ WP_Error 。詳しくは is_wp_error() を参照。

用例

下記の例は、投稿( $post )に付けられた 'product' タクソノミーのすべてのタームをリスト表示します。

$product_terms = wp_get_object_terms( $post->ID,  'product' );
if ( ! empty( $product_terms ) ) {
	if ( ! is_wp_error( $product_terms ) ) {
		echo '<ul>';
			foreach( $product_terms as $term ) {
				echo '<li><a href="' . get_term_link( $term->slug, 'product' ) . '">' . esc_html( $term->name ) . '</a></li>'; 
			}
		echo '</ul>';
	}
}

参考

  • グローバル変数 (object) $wpdb を使用します。
  • WP_Error オブジェクトを返す場合があります。

変更履歴

バージョン 2.3.0 にて導入されました。

ソースファイル

wp_get_object_terms()wp-includes/taxonomy.php にあります。

タームタグ: is_term(), term_exists(), get_objects_in_term(), get_term(), get_term_by(), get_term_children(), get_term_link(), get_terms(), get_the_terms(), get_the_term_list(), has_term(), sanitize_term(), the_terms(), get_object_taxonomies() is_object_in_taxonomy() the_taxonomies() wp_get_object_terms(), wp_set_object_terms(), wp_get_post_terms(), wp_set_post_terms(), wp_delete_object_term_relationships()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_get_object_terms最新版との差分