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

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

関数リファレンス/get term

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

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

戻り値

(mixed | null | WP_Error) 
データベースから取得したタームのオブジェクト。$term が空なら null を返す(タームとタクソノミーの組み合わせが無い)。タクソノミーが存在しなければ WP_Error が返される。

用例

get_term は便利な情報を何種類か得られますが、残念ながらリンク情報はありません。

<?php
    $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 を使用します。

変更履歴

ソースファイル

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