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

「関数リファレンス/get objects in term」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(wp_parse_args() のリンク先を日本語Codexへ。)
(最初の和訳。)
1行目: 1行目:
{{NeedTrans}}
+
<div id="Description">
 +
== 説明 ==
 +
</div>
 +
指定されたターム(複数でもよい)が付いているオブジェクトの ID を取得します。
 +
タームは、指定されたタクソノミーのタームとします。
  
== Description ==
+
<tt>$taxonomies</tt> の文字列は、この関数を実行する前に登録済みでなければなりません。
Retrieves the object_id(s) belonging to a term in a taxonomy.
+
有効なタクソノミーが見つからなければ WP_Error を返します。
Which Objects have the given term from the given taxonomy.
+
WP_Error は PHP 5 の例外のようなものですが、WordPress ではキャッチ処理ができません。
 +
しかし WP_Error が返されたかチェックしてエラーメッセージを取得できます。
  
The strings of <tt>$taxonomies</tt> must exist before this function will continue. On failure of finding a valid taxonomy, it will return an WP_Error class, kind of like Exceptions in PHP 5, except you can't catch them. Even so, you can still test for the WP_Error class and get the error message.
+
<tt>$term_ids</tt> は <tt>$taxonomies</tt> のようにはチェックされません。
 +
しかしオブジェクトの ID を取得する為には予め存在していなければなりません。
  
The <tt>$terms</tt> aren't checked the same as <tt>$taxonomies</tt>, but still need to exist for <tt>$object_ids</tt> to be returned.
+
返されるオブジェクト ID の順序を変更できます。
 +
PHP のソート系の関数を使用するか、または <tt>$args</tt> に ASC か DESC を与えます。
 +
ASC と DESC は、キー '<tt>order</tt>' に指定します。
  
It is possible to change the order that object_ids is returned by either using PHP sort family functions or using the database by using <tt>$args</tt> with either ASC or DESC array. The value should be in the key named '<tt>order</tt>'.
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
 +
<?php get_objects_in_term( $term_ids, $taxonomies, $args ) ?>
  
== Usage ==
+
<div id="Parameters">
<pre>
+
== パラメータ ==
<?php get_objects_in_term( $term_ids, $taxonomies, $args ) ?>
+
</div>
</pre>
+
{{Parameter|$term_ids|整数&#124;配列|タームの ID、またはターム ID の配列。}}
 +
{{Parameter|$taxonomies|文字列&#124;配列|タクソノミー名の文字列、またはタクソノミー名の文字列を要素とする配列。}}
 +
{{Parameter|$args|配列&#124;文字列|戻り値の種類を指定。|オプション|array()}}
  
== Parameters ==
+
<div id="Possible Arguments">
{{Parameter|$term_ids|integer&#124;array|Term id or array of term ids of terms that will be used}}
+
=== 指定可能な引数 ===
{{Parameter|$taxonomies|string&#124;array|String of taxonomy name or Array of string values of taxonomy names}}
+
</div>
{{Parameter|$args|array&#124;optional|array()}}
+
; order : (''文字列'')
===Possible Arguments===
+
:* <tt>ASC</tt> - デフォルト:昇順にソートする。
 +
:* <tt>DESC</tt> :降順にソートする。
  
; order : (''string'')
+
'''参考''': 引数は [[関数リファレンス/wp_parse_args|wp_parse_args()]] 関数が使用する形式で与えます。
:* <tt>ASC</tt> - Default
+
<!-- 原文の行末に e.g. と書かれていたので、サンプルを記載するつもりだったようです。 -->
:* <tt>DESC</tt>
+
  
'''NOTE''': Arguments are passed in the format used by [[関数リファレンス/wp_parse_args|wp_parse_args()]]. e.g.
+
<div id="Return Values">
 +
== 戻り値 ==
 +
</div>
 +
; (WP_Error&#124;配列) : タクソノミーが存在しなければ WP_Error を返す。オブジェクトが一つも見つからなければ空の配列を返す。見つかればオブジェクト ID の配列を返す。
  
== Return Values ==
+
'''参考''': 一つのオブジェクトに、$term_ids に与えたタームの 2 つ以上が付いていると、オブジェクト ID が重複して含まれる結果になります。
; (WP_Error&#124;array) : If the taxonomy does not exist, then WP_Error will be returned. On success the array can be empty meaning that there are no <tt>$object_ids</tt> found or it will return an array of the <tt>$object_ids</tt> found.
+
  
'''NOTE''': If an object is in more than one of the terms passed to $terms, the results returned will contain duplicate object_ids
+
<div id="Examples">
 
+
== ==
== Examples ==
+
</div>
 
<!-- Need creative examples. Feel free to link to external examples. -->
 
<!-- Need creative examples. Feel free to link to external examples. -->
 +
{{募集中||クリエイティブな例を求めています。外部サイトへのリンクでも構いません。|情報}}
  
== Notes ==
+
<div id="Notes">
* Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]]
+
== 参考 ==
* Uses: [[関数リファレンス/wp_parse_args|<tt>wp_parse_args()</tt>]] Creates an array from string <tt>$args</tt>.
+
</div>
* Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]]
+
* [[関数リファレンス/wp_parse_args|<tt>wp_parse_args()</tt>]] 関数を使って、文字列形式の <tt>$args</tt> を配列に変換します。
 +
* グローバル変数 (<tt>object</tt>) [[クラスリファレンス/wpdb|<tt>$wpdb</tt>]] を使用します。
  
== Change Log ==
+
<div id="Change Log">
Since: 2.3.0
+
== 変更履歴 ==
 +
</div>
 +
バージョン [[Version 2.3|2.3.0]] にて導入されました。
  
== Source File ==
+
<div id="Source File">
<tt>get_objects_in_term()</tt> is located in {{Trac|/wp-includes/taxonomy.php}}.
+
== ソースファイル ==
 
+
</div>
== Related ==
+
<tt>get_objects_in_term()</tt> {{Trac|/wp-includes/taxonomy.php}} にあります。
<!--
+
    To Do:
+
    Need to find related functions.
+
    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.
+
-->
+
  
 +
<div id="Related">
 +
== 関連項目 ==
 +
</div>
 
{{Term Tags}}
 
{{Term Tags}}
 
 
{{Tag Footer}}
 
{{Tag Footer}}
  

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

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

$taxonomies の文字列は、この関数を実行する前に登録済みでなければなりません。 有効なタクソノミーが見つからなければ WP_Error を返します。 WP_Error は PHP 5 の例外のようなものですが、WordPress ではキャッチ処理ができません。 しかし WP_Error が返されたかチェックしてエラーメッセージを取得できます。

$term_ids$taxonomies のようにはチェックされません。 しかしオブジェクトの ID を取得する為には予め存在していなければなりません。

返されるオブジェクト ID の順序を変更できます。 PHP のソート系の関数を使用するか、または $args に ASC か DESC を与えます。 ASC と DESC は、キー 'order' に指定します。

使い方

<?php get_objects_in_term( $term_ids, $taxonomies, $args ) ?>

パラメータ

$term_ids
整数|配列) (必須) タームの ID、またはターム ID の配列。
初期値: なし
$taxonomies
文字列|配列) (必須) タクソノミー名の文字列、またはタクソノミー名の文字列を要素とする配列。
初期値: なし
$args
配列|文字列) (オプション) 戻り値の種類を指定。
初期値: array()

指定可能な引数

order 
(文字列)
  • ASC - デフォルト:昇順にソートする。
  • DESC :降順にソートする。

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

戻り値

(WP_Error|配列) 
タクソノミーが存在しなければ WP_Error を返す。オブジェクトが一つも見つからなければ空の配列を返す。見つかればオブジェクト ID の配列を返す。

参考: 一つのオブジェクトに、$term_ids に与えたタームの 2 つ以上が付いていると、オブジェクト ID が重複して含まれる結果になります。

情報募集中 クリエイティブな例を求めています。外部サイトへのリンクでも構いません。 該当部分を編集するか、このページのノートまたはフォーラム等で教えてください。


参考

  • wp_parse_args() 関数を使って、文字列形式の $args を配列に変換します。
  • グローバル変数 (object) $wpdb を使用します。

変更履歴

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

ソースファイル

get_objects_in_term()/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/get objects in term最新版との差分