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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/get term 19:41, 9 November 2013 Jdgrimes 版を流し込み。)
(改めて和訳。)
1行目: 1行目:
{{NeedTrans}}
+
<div id="Description">
 +
== 説明 ==
 +
</div>
 +
ターム ID を指定してタームの全データをデータベースから取得します。
 +
名前やスラッグで(ID でも可能)取得するには [[関数リファレンス/get_term_by|<tt>get_term_by()</tt>]] を使います。
  
== Description ==
+
get_term 関数を使うと、タームのオブジェクトにフィルターを適用できます。
Get all Term data from database by Term ID. To retrieve term data by name, slug or ID, use [[関数リファレンス/get_term_by|get_term_by()]] instead
+
フィルターを適用せずにデータベースからタームのオブジェクトを取得することもできます。
  
The usage of the get_term function is to apply filters to a term object. It is possible to get a term object from the database before applying the filters.
+
ターム ID は指定したタクソノミーのものでなければデータベースから取得できません。
 +
この取得失敗はフックにより処理できるかもしれません。
 +
失敗したことを表す値は、[[クラスリファレンス/wpdb|<tt>$wpdb</tt>]] の get_row メソッドが返す値と同じです。
  
<tt>$term</tt> ID must be part of <tt>$taxonomy</tt>, to get from the database. Failure, might be able to be captured by the hooks. Failure would be the same value as [[クラスリファレンス/wpdb|<tt>$wpdb</tt>]] returns for the get_row method.
+
フックは二つあり、タームに対する '<tt>get_term</tt>' とタクソノミー名に対する '<tt>term_$taxonomy</tt>' です。
 +
両方とも、タームのオブジェクトとタクソノミー名をパラメータとして受け取ります。
 +
またフックは両方ともタームのオブジェクトを返すと想定されています。
  
There are two hooks, one is specifically for each term, named '<tt>get_term</tt>', and the second is for the taxonomy name, '<tt>term_$taxonomy</tt>'. Both hooks gets the term object, and the taxonomy name as parameters. Both hooks are expected to return a Term object.
+
'<tt>get_term</tt>' フック - タームのオブジェクトとタクソノミー名の二つのパラメータを受け取る。必ずタームのオブジェクトを返す。[[関数リファレンス/get_term|<tt>get_term()</tt>]] の中で、どの <tt>$term</tt> に対してもフィルターとして使われる。
  
'<tt>get_term</tt>' hook - Takes two parameters the term Object and the taxonomy name. Must return term object. Used in [[関数リファレンス/get_term|<tt>get_term()</tt>]] as a catch-all filter for every <tt>$term</tt>.
+
'<tt>get_$taxonomy</tt>' フック - タームのオブジェクトとタクソノミー名の二つのパラメータを受け取る。必ずタームのオブジェクトを返す。<tt>$taxonomy</tt> はタクソノミー名なので、例えば '<tt>category</tt>' ならばフィルター名は '<tt>get_category</tt>' になる。カスタムタクソノミー(カスタム分類)の場合や、デフォルトのタクソノミーにプラグインする(動作を変える)のに便利。
  
'<tt>get_$taxonomy</tt>' hook - Takes two parameters the term Object and the taxonomy name. Must return term object. <tt>$taxonomy</tt> will be the taxonomy name, so for example, if '<tt>category</tt>', it would be '<tt>get_category</tt>' as the filter name. Useful for custom taxonomies or plugging into default taxonomies.
+
<div id="Usage">
 
+
== 使い方 ==
== Usage ==
+
</div>
 
  <?php get_term( $term, $taxonomy, $output, $filter ) ?>
 
  <?php get_term( $term, $taxonomy, $output, $filter ) ?>
  
== Parameters ==
+
<div id="Parameters">
{{Parameter|$term|integer&#124;object|If integer, will get from database. If object will apply filters and return <tt>$term</tt>.}}
+
== パラメータ ==
{{Parameter|$taxonomy|string|Taxonomy name that <tt>$term</tt> is part of.}}
+
</div>
{{Parameter|$output|string|Constant OBJECT, ARRAY_A, or ARRAY_N|optional|OBJECT}}
+
{{Parameter|$term|整数&#124;オブジェクト|整数ならデータベースから取得を行う。オブジェクトならフィルターを適用して <tt>$term</tt> を返す。}}
{{Parameter|$filter|string|default is raw or no WordPress defined filter will applied.|optional|'raw'}}
+
{{Parameter|$taxonomy|文字列|<tt>$term</tt> が含まれるタクソノミーの名前。}}
 +
{{Parameter|$output|文字列|定数 OBJECT, ARRAY_A, ARRAY_N の何れか。|オプション|OBJECT}}
 +
{{Parameter|$filter|文字列|デフォルトは raw で、その場合 WordPress の既定のフィルターはどれも適用されない。|オプション|'raw'}}
  
== Return Values ==
+
<div id="Return Values">
; (mixed&#124;null&#124;WP_Error) : Term Row from database. Will return null if <tt>$term</tt> is empty. If taxonomy does not exist then <tt>[[クラスリファレンス/WP_Error | WP_Error]]</tt> will be returned.
+
== 戻り値 ==
 +
</div>
 +
; (mixed&#124;null&#124;WP_Error) : データベースから取得したタームの行。<tt>$term</tt> が空なら null を返す。タクソノミーが存在しなければ <tt>[[クラスリファレンス/WP_Error | WP_Error]]</tt> が返される。
  
== 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. -->
Get Term offers some handy information, but unfortunately lacks a link value.
+
get_term はちょっと便利な情報を得られますが、残念ながらリンク情報が不足しています。
 +
<!-- Get Term offers some handy information, but unfortunately lacks a link value. -->
  
 
<code>$term = get_term( $term_id, $taxonomy );</code>  
 
<code>$term = get_term( $term_id, $taxonomy );</code>  
  
Gives you term slug: e.g.: term-slug-example
+
タームのスラッグを参照:(例: term-slug-example
  
 
<code>$slug = $term->slug;</code>
 
<code>$slug = $term->slug;</code>
  
Gives you term name: e.g. Term Name Example
+
タームの名前を参照:(例: Term Name Example
  
 
<code>$name = $term->name;</code>
 
<code>$name = $term->name;</code>
  
Gives you term description: e.g. This is my new cool custom term.
+
タームの説明を参照:(例: This is my new cool custom term.
  
 
<code>$desc = $term->description;</code>
 
<code>$desc = $term->description;</code>
  
== Notes ==
+
<div id="Notes">
* See [[関数リファレンス/sanitize_term_field|<tt>sanitize_term_field()</tt>]] The <tt>$context</tt> param lists the available values for [[関数リファレンス/get_term_by|<tt>get_term_by()</tt>]] <tt>$filter</tt> param.
+
== 参考 ==
* Uses: [[関数リファレンス/sanitize_term|<tt>sanitize_term()</tt>]] Cleanses the term based on <tt>$filter</tt> context before returning.
+
</div>
* Uses global: (<tt>object</tt>) [[クラスリファレンス/wpdb|<tt>$wpdb</tt>]]
+
* <tt>$filter</tt> パラメータに指定可能な値は、[[関数リファレンス/sanitize_term_field|<tt>sanitize_term_field()</tt>]] <tt>$context</tt> パラメータのリストを見てください。
 +
* タームを返す前に、[[関数リファレンス/sanitize_term|<tt>sanitize_term()</tt>]] を使用して、<tt>$filter</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">
<!-- Need links to current source code files -->
+
== ソースファイル ==
<tt>&get_term()</tt> is located in {{Trac|wp-includes/taxonomy.php}}.
+
</div>
 +
<tt>get_term()</tt> {{Trac|wp-includes/taxonomy.php}} にあります。
  
== Related ==
+
<div id="Related">
 +
== 関連項目 ==
 +
</div>
 
{{Term Tags}}
 
{{Term Tags}}
  

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

ターム ID を指定してタームの全データをデータベースから取得します。 名前やスラッグで(ID でも可能)取得するには get_term_by() を使います。

get_term 関数を使うと、タームのオブジェクトにフィルターを適用できます。 フィルターを適用せずにデータベースからタームのオブジェクトを取得することもできます。

ターム ID は指定したタクソノミーのものでなければデータベースから取得できません。 この取得失敗はフックにより処理できるかもしれません。 失敗したことを表す値は、$wpdb の get_row メソッドが返す値と同じです。

フックは二つあり、タームに対する 'get_term' とタクソノミー名に対する 'term_$taxonomy' です。 両方とも、タームのオブジェクトとタクソノミー名をパラメータとして受け取ります。 またフックは両方ともタームのオブジェクトを返すと想定されています。

'get_term' フック - タームのオブジェクトとタクソノミー名の二つのパラメータを受け取る。必ずタームのオブジェクトを返す。get_term() の中で、どの $term に対してもフィルターとして使われる。

'get_$taxonomy' フック - タームのオブジェクトとタクソノミー名の二つのパラメータを受け取る。必ずタームのオブジェクトを返す。$taxonomy はタクソノミー名なので、例えば 'category' ならばフィルター名は 'get_category' になる。カスタムタクソノミー(カスタム分類)の場合や、デフォルトのタクソノミーにプラグインする(動作を変える)のに便利。

使い方

<?php get_term( $term, $taxonomy, $output, $filter ) ?>

パラメータ

$term
整数|オブジェクト) (必須) 整数ならデータベースから取得を行う。オブジェクトならフィルターを適用して $term を返す。
初期値: なし
$taxonomy
文字列) (必須$term が含まれるタクソノミーの名前。
初期値: なし
$output
文字列) (オプション) 定数 OBJECT, ARRAY_A, ARRAY_N の何れか。
初期値: OBJECT
$filter
文字列) (オプション) デフォルトは raw で、その場合 WordPress の既定のフィルターはどれも適用されない。
初期値: 'raw'

戻り値

(mixed|null|WP_Error) 
データベースから取得したタームの行。$term が空なら null を返す。タクソノミーが存在しなければ WP_Error が返される。

get_term はちょっと便利な情報を得られますが、残念ながらリンク情報が不足しています。

$term = get_term( $term_id, $taxonomy );

タームのスラッグを参照:(例: term-slug-example )

$slug = $term->slug;

タームの名前を参照:(例: Term Name Example )

$name = $term->name;

タームの説明を参照:(例: This is my new cool custom term. )

$desc = $term->description;

参考

  • $filter パラメータに指定可能な値は、sanitize_term_field()$context パラメータのリストを見てください。
  • タームを返す前に、sanitize_term() を使用して、$filter のコンテキストに基づいてクレンジングします。
  • グローバル変数 (object) $wpdb を使用します。

変更履歴

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

ソースファイル

get_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 term最新版との差分