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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/wp_get_object_terms 09:09, 26 February 2014 Mfrerebeau 版を流し込み。)
 
(最初の和訳。)
1行目: 1行目:
{{NeedTrans}}
+
<div id="Description">
 +
== 説明 ==
 +
</div>
 +
指定されたオブジェクト(複数でもよい)に付いている、指定されたタクソノミー(カスタム分類)のタームを取得します。
  
== Description ==
+
<div id="Usage">
Retrieves the terms associated with the given object(s), in the supplied taxonomies.
+
== 使い方 ==
 
+
</div>
== Usage ==
+
 
  <?php wp_get_object_terms( $object_ids, $taxonomies, $args ) ?>
 
  <?php wp_get_object_terms( $object_ids, $taxonomies, $args ) ?>
  
== Parameters ==
+
<div id="Parameters">
{{Parameter|$object_ids|string&#124;array|The id's of objects to retrieve terms from.}}
+
== パラメータ ==
{{Parameter|$taxonomies|string&#124;array|The [[Taxonomies|taxonomies]] to retrieve terms from. For example: 'category', 'post_tag', 'taxonomy slug'}}
+
</div>
{{Parameter|$args|array&#124;string|Change what is returned|optional|array}}
+
{{Parameter|$object_ids|文字列&#124;配列|タームを取得するオブジェクトの ID 。}}
 +
{{Parameter|$taxonomies|文字列&#124;配列|タームを取得する[[カスタム分類|タクソノミー]]。例: 'category', 'post_tag', 'taxonomy slug'}}
 +
{{Parameter|$args|配列&#124;文字列|戻り値の種類を指定。|オプション|配列}}
  
=== Default Arguments ===
+
<div id="Default Arguments">
  $args = array('orderby' => 'name', 'order' => 'ASC', 'fields' => 'all');
+
=== デフォルトの引数 ===
 +
</div>
 +
  $args = array( 'orderby' => 'name', 'order' => 'ASC', 'fields' => 'all' );
  
=== Argument Options ===
+
<div id="Argument Options">
 +
=== 引数のオプション ===
 +
</div>
  
The following information has to do the <tt>$args</tt> parameter and for what can be contained in the string or array of that parameter, if it exists.
+
以下の情報を <tt>$args</tt> パラメータに指定できます。指定する場合は文字列形式または配列とします。
 +
<!-- The following information has to do the <tt>$args</tt> parameter and for what can be contained in the string or array of that parameter, if it exists. -->
  
; order : (''string'')
+
; order : (''文字列'')
:* <tt>ASC</tt> - Default
+
:* <tt>ASC</tt> - デフォルト:昇順にソートする。
:* <tt>DESC</tt>
+
:* <tt>DESC</tt> :降順にソートする。
  
; orderby : (''string'')
+
; orderby : (''文字列'')
:* <tt>name</tt> - Default
+
:* <tt>name</tt> - デフォルト:名前でソートする。
:* <tt>count</tt>
+
:* <tt>count</tt> :タームの使用回数でソートする。
:* <tt>slug</tt>
+
:* <tt>slug</tt> :スラッグでソートする。
:* <tt>term_group</tt>
+
:* <tt>term_group</tt> :タームのグループでソートする。
:* <tt>term_order</tt>
+
:* <tt>term_order</tt> :タームの順序でソートする。
:* <tt>term_id</tt>
+
:* <tt>term_id</tt> :タームの ID でソートする。
:* <tt>none</tt>
+
:* <tt>none</tt> :ソートしない。
  
; fields : (''string'')
+
; fields : (''文字列'')
:* <tt>all</tt> - Default : all matching terms objects will be returned.
+
:* <tt>all</tt> - デフォルト:マッチするすべてのタームのオブジェクトを返す。
:* <tt>ids</tt> : terms ids will be returned
+
:* <tt>ids</tt> :タームの ID を返す。
:* <tt>names</tt> : terms names will be returned
+
:* <tt>names</tt> :タームの名前を返す。
:* <tt>slugs</tt> : terms slugs will be returned
+
:* <tt>slugs</tt> :タームのスラッグを返す。
:* <tt>all_with_object_id</tt> : all matching terms objects will be returned.
+
:* <tt>all_with_object_id</tt> :マッチするすべてのタームのオブジェクトと、そのオブジェクトの ID を返す。
:* <tt>tt_ids</tt> : terms taxonomies ids will be returned
+
:* <tt>tt_ids</tt> :ターム・タクソノミー ID を返す。<!-- terms taxonomies ids will be returned -->
  
'''NOTE''': Arguments are passed in the format used by [[Function_Reference/wp_parse_args|wp_parse_args()]]. e.g.
+
'''参考''': 引数は [[関数リファレンス/wp_parse_args|wp_parse_args()]] 関数が使用する形式で与えます。
 +
<!-- 原文の行末に e.g. と書かれていたので、サンプルを記載するつもりだったようです。 -->
  
== Return Values ==
+
<div id="Return Values">
; (array&#124;WP_Error) : Array of requested term objects or empty array if no terms found. WP_Error if <tt>$taxonomy</tt> does not exist. See [[Function_Reference/is_wp_error|is_wp_error()]] for more information.
+
== 戻り値 ==
 +
</div>
 +
; (配列&#124;WP_Error) : 指定された条件に合ったタームのオブジェクト等。タームが見つからない場合は空の配列。もし <tt>$taxonomy</tt> が存在しなければ WP_Error 。詳しくは [[関数リファレンス/is_wp_error|is_wp_error()]] を参照。
  
== Examples ==
+
<div id="Examples">
 +
== 例 ==
 +
</div>
 
<!-- Need creative examples. Feel free to link to external examples. -->
 
<!-- Need creative examples. Feel free to link to external examples. -->
Return a list of all 'product' taxonomy terms which are applied to <tt>$post</tt>:
+
下記の例は、投稿( <tt>$post</tt> )に付けられた 'product' タクソノミーのすべてのタームをリスト表示します。
 
<pre>
 
<pre>
 
$product_terms = wp_get_object_terms($post->ID, 'product');
 
$product_terms = wp_get_object_terms($post->ID, 'product');
61行目: 75行目:
 
</pre>
 
</pre>
  
== Notes ==
+
<div id="Notes">
* Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]]
+
== 参考 ==
* May return [[Function_Reference/WP_Error|<tt>WP_Error</tt>]] object.
+
</div>
 +
* グローバル変数 (<tt>object</tt>) [[クラスリファレンス/wpdb|<tt>$wpdb</tt>]] を使用します。
 +
* [[関数リファレンス/WP_Error|<tt>WP_Error</tt>]] オブジェクトを返す場合があります。
  
== Change Log ==
+
<div id="Change Log">
Since: 2.3.0
+
== 変更履歴 ==
 +
</div>
 +
バージョン [[Version 2.3|2.3.0]] にて導入されました。
  
== Source File ==
+
<div id="Source File">
<!-- Need links to current source code files -->
+
== ソースファイル ==
<tt>wp_get_object_terms()</tt> is located in {{Trac|wp-includes/taxonomy.php}}.
+
</div>
 +
<tt>wp_get_object_terms()</tt> {{Trac|wp-includes/taxonomy.php}} にあります。
  
== Related ==
+
<div id="Related">
 +
== 関連項目 ==
 +
</div>
 
{{Term Tags}}
 
{{Term Tags}}
 
{{Tag Footer}}
 
{{Tag Footer}}

2014年7月30日 (水) 00:46時点における版

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

使い方

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

パラメータ

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

デフォルトの引数

$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').'">'.$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最新版との差分