当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/wp get post terms」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/wp_get_post_terms 09:23, 6 June 2014 Juniperpaul 版を流し込み。)
 
(最新のマージ <!--22:18, 1 August 2015‎ Garydarling 版 -->)
 
(他の1人の利用者による、間の3版が非表示)
1行目: 1行目:
{{NeedTrans}}
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
== Description ==
+
投稿に付けられたタームを取得します。
Retrieve the terms for a post.
+
  
There is only one default for this function, called '<tt>fields</tt>' and by default is set to '<tt>all</tt>'. Other values can be '<tt>names</tt>' or '<tt>ids</tt>'. There are other defaults that can be overridden in [[Function_Reference/wp_get_object_terms|<tt>wp_get_object_terms()</tt>]].
+
この関数にはデフォルトが一つだけあり、'<tt>fields</tt>' がデフォルトで '<tt>all</tt>' にセットされます。
 +
他の値として '<tt>names</tt>' または '<tt>ids</tt>' を指定できます。
 +
他にも [[関数リファレンス/wp_get_object_terms|<tt>wp_get_object_terms()</tt>]] に示されているデフォルトがあり、変更できます。
 +
 
 +
<div id="Usage">
 +
== 使用法 ==
 +
</div>
  
== Usage ==
 
 
  <?php $terms = wp_get_post_terms( $post_id, $taxonomy, $args ); ?>
 
  <?php $terms = wp_get_post_terms( $post_id, $taxonomy, $args ); ?>
  
== Parameters ==
+
<div id="Parameters">
{{Parameter|$post_id|integer|The Post ID|optional|0}}
+
== パラメータ ==
{{Parameter|$taxonomy|string&#124;array|The taxonomy for which to retrieve terms. Defaults to post_tag.|optional|'post_tag'}}
+
</div>
{{Parameter|$args|array|Overwrite the defaults|optional|array}}
+
  
=== Default Arguments ===
+
{{Parameter|$post_id|整数|投稿 ID|オプション|0}}
$args = array('orderby' => 'name', 'order' => 'ASC', 'fields' => 'all');
+
{{Parameter|$taxonomy|文字列&#124;配列|タームを取得するコンテキストであるタクソノミー。デフォルトは投稿タグ。|オプション|'post_tag'}}
 +
{{Parameter|$args|配列|デフォルトを変更可能。|オプション|<tt>array()</tt>}}
  
== Return Values ==
+
<p class="information"><tt>$args</tt> に指定できるオプションの一覧は [[関数リファレンス/wp_get_object_terms|<tt>wp_get_object_terms()</tt>]] を参照してください。</p>
; (array) : List of post tags.
+
  
===Variables in Returned Object===
+
<div id="Default_Arguments">
 +
=== デフォルトの引数 ===
 +
</div>
  
;term_id :the id of the term itself
+
$args = array( 'orderby' => 'name', 'order' => 'ASC', 'fields' => 'all' );
;name :the term name
+
;slug :a slug generated from the term name
+
;term_group :the term_id of the parent term (also stored as 'parent')
+
;term_taxonomy_id :the id of the taxonomy that the term belongs to
+
;taxonomy :the name of the taxonomy that the term belongs to
+
;description :the taxonomy description
+
;parent :the term_id of the parent term (also stored as 'term_group')
+
;count :the number of uses of this term
+
  
== Examples ==
+
<div id="Return Values">
 +
== 戻り値 ==
 +
</div>
 +
 
 +
; (配列&#124;WP_Error) : タームのリスト。<tt>$taxonomy</tt> が存在しなければ WP_Error を返す。詳しくは [[関数リファレンス/is_wp_error|is_wp_error()]] を参照。
 +
 
 +
<div id="Variables_in_Returned_Object">
 +
=== 返されるオブジェクトに含まれる変数 ===
 +
</div>
 +
 
 +
;term_id (整数) : タームの ID
 +
;name (文字列) : タームの名前
 +
;slug (文字列) : ターム名から生成されたスラッグ
 +
;term_group (整数) : 親タームのターム ID ('parent' としても格納される)
 +
;term_taxonomy_id (整数) : タームが属するタクソノミーの ID
 +
;taxonomy (文字列) : タームが属するタクソノミーの名前
 +
;description (文字列) : タクソノミーの説明
 +
;parent (整数) : 親タームのターム ID ('term_group' としても格納される)
 +
;count (整数) : このタームが使われている回数
 +
 
 +
<div id="Examples">
 +
== 例 ==
 +
</div>
  
 
<pre>
 
<pre>
//Returns All Term Items for "my_taxonomy"
+
// タクソノミー "my_taxonomy" のすべてのターム情報を返す
 
$term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "all"));
 
$term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "all"));
 
print_r($term_list);
 
print_r($term_list);
  
//Returns Array of Term Names for "my_taxonomy"
+
// タクソノミー "my_taxonomy" のターム名の配列を返す
 
$term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "names"));
 
$term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "names"));
 
print_r($term_list);
 
print_r($term_list);
  
//Returns Array of Term ID's for "my_taxonomy"
+
// タクソノミー "my_taxonomy" のターム ID の配列を返す
 
$term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "ids"));
 
$term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "ids"));
 
print_r($term_list);
 
print_r($term_list);
 
</pre>
 
</pre>
  
== Notes ==
+
//単一の値を呼び出す - $term_list はオブジェクトの配列です。
* Uses: [[Function_Reference/wp_get_object_terms|<tt>wp_get_object_terms()</tt>]] Gets the tags for returning.
+
//そのプロパティ(フィールド)を参照する前に、配列エントリのいずれかを選択する必要があります。
 +
$term_list = wp_get_post_terms($post->ID, 'my_taxonomy', array("fields" => "all"));
 +
echo $term_list[0]->description ;</pre>
 +
 
 +
<div id="Notes">
 +
== 参考 ==
 +
</div>
 +
 
 +
* [[関数リファレンス/wp_get_object_terms|<tt>wp_get_object_terms()</tt>]] を使用して、返すターム(タグ等)を取得します。
 +
 
 +
<div id="Change_Log">
 +
== 改訂履歴 ==
 +
</div>
  
== Change Log ==
+
[[Version 2.8|2.8.0]] にて導入されました。
Since: 2.8.0
+
  
== Source File ==
+
<div id="Source_File">
<!-- Need links to current source code files -->
+
== ソースファイル ==
<tt>wp_get_post_terms()</tt> is located in {{Trac|wp-includes/post.php}}.
+
</div>
  
== Related ==
+
<tt>wp_get_post_terms()</tt> は {{Trac|wp-includes/post.php}} にあります。
  
<!--
+
<div id="Related">
    To Do:
+
== 関連項目 ==
    Need to find related functions.
+
</div>
    Need to create groups of functions and create templates to add them to a page quickly.
+
    Some functions may be related to many groups of functions.
+
-->
+
  
 
{{Term Tags}}
 
{{Term Tags}}
71行目: 100行目:
 
{{Tag Footer}}
 
{{Tag Footer}}
  
{{原文|Function Reference/wp_get_post_terms|144061}}<!-- 09:23, 6 June 2014 Juniperpaul 版 -->
+
{{原文|Function Reference/wp_get_post_terms|152995}}<!--22:18, 1 August 2015‎ Garydarling  版 -->
  
 
{{DEFAULTSORT:Wp_get_post_terms}}
 
{{DEFAULTSORT:Wp_get_post_terms}}
[[Category:Functions]]
+
[[Category:関数]]
 +
[[Category:タクソノミー]]
  
 
[[en:Function Reference/wp_get_post_terms]]
 
[[en:Function Reference/wp_get_post_terms]]

2015年8月14日 (金) 08:42時点における最新版

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

この関数にはデフォルトが一つだけあり、'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最新版との差分