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

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

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

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

投稿に付けられたタームを取得します。

この関数にはデフォルトが一つだけあり、'fields' がデフォルトで 'all' にセットされます。 他の値として 'names' または 'ids' を指定できます。 他にも wp_get_object_terms() に示されているデフォルトがあり、変更できます。

使用法

<?php $terms = wp_get_post_terms( $post_id, $taxonomy, $args ); ?>

パラメータ

$post_id
整数) (オプション) 投稿 ID
初期値: 0
$taxonomy
文字列|配列) (オプション) タームを取得するコンテキストであるタクソノミー。デフォルトは投稿タグ。
初期値: 'post_tag'
$args
配列) (オプション) デフォルトを変更可能。
初期値: array()

$args に指定できるオプションの一覧は wp_get_object_terms() を参照してください。

デフォルトの引数

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

戻り値

(配列|WP_Error) 
タームのリスト。$taxonomy が存在しなければ WP_Error を返す。詳しくは is_wp_error() を参照。

返されるオブジェクトに含まれる変数

term_id (整数) 
タームの ID
name (文字列) 
タームの名前
slug (文字列) 
ターム名から生成されたスラッグ
term_group (整数) 
親タームのターム ID ('parent' としても格納される)
term_taxonomy_id (整数) 
タームが属するタクソノミーの ID
taxonomy (文字列) 
タームが属するタクソノミーの名前
description (文字列) 
タクソノミーの説明
parent (整数) 
親タームのターム ID ('term_group' としても格納される)
count (整数) 
このタームが使われている回数

// タクソノミー "my_taxonomy" のすべてのターム情報を返す
$term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "all"));
print_r($term_list);

// タクソノミー "my_taxonomy" のターム名の配列を返す
$term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "names"));
print_r($term_list);

// タクソノミー "my_taxonomy" のターム ID の配列を返す
$term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "ids"));
print_r($term_list);

//単一の値を呼び出す - $term_list はオブジェクトの配列です。 //そのプロパティ(フィールド)を参照する前に、配列エントリのいずれかを選択する必要があります。 $term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "all")); echo $term_list[0]->description ;</pre>

参考

改訂履歴

2.8.0 にて導入されました。

ソースファイル

wp_get_post_terms()wp-includes/post.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_post_terms最新版との差分