get_term

説明

mixed get_term( mixed $term [ , string $taxonomy = '' [ , string $output = OBJECT [ , string $filter = 'raw' ] ] ] )
IDを指定してカテゴリー・タグ情報を取得する。

パラメータ

  • $term
    ID(term_id)またはカテゴリー・タグ情報のオブジェクトを指定。
  • $taxonomy
    タクソノミー名として'category'、'post_tag'、'link_category'などを指定([4.4.0]省略時は'')。
  • $output
    出力型を示すOBJECT、ARRAY_A、ARRAY_Nの何れか(省略時はOBJECT)。
  • $filter
    フィルター名(省略時は'raw')。

返り値

カテゴリー・タグが見つかった場合はそのカテゴリー・タグ情報をパラメータ$outputで指定された型で返す。カテゴリー・タグが見つからなかった場合はnullを返す。また、パラメータ$termが空の場合、$taxonomyが無効なタクソノミー名の場合は WP_Errorのオブジェクトを返す。 $outputがOBJECTの場合(デフォルト)、メンバー変数は次の通り。
プロパティ名データ型意味
term_idintID
namestring名前
slugstringスラッグ
term_groupintグループID
term_taxonomy_idintタクソノミーID
taxonomystringタクソノミー名。カテゴリーの場合は'category'、タグの場合は'post_tag'となる
descriptionstring説明
parentint親カテゴリーID。親カテゴリーがない場合は0となる
countint投稿数

注意

返り値はWP_Errorのオブジェクトの場合あるので、返り値がオブジェクトであっても is_wp_error関数で確認するのが望ましい。 またパラメータ$termにカテゴリー・タグ情報のオブジェクトを指定した場合、フィルター処理を行った後、$outputで指定した型に変換したデータを返す。

[4.4.0]パラメータ$taxonomyは省略可能になった。


使用例

  • IDが10のカテゴリー情報を取得する。
    <?php $cat = get_term( 10, 'category' ); ?>

フィルター

[2.3.0]ターム情報を取得した直前に'get_term'フィルターを呼び出す。パラメータ$_termには取得したターム情報が、$taxonomyには本関数が受け取った値が格納されている。
$_term = apply_filters( 'get_term', $_term, $taxonomy );
[2.3.0]'get_term'フィルターの直前に"get_$taxonomy"フィルターを呼び出す($taxonomyはタクソノミー名)。パラメータ$_termには取得したターム情報が、$taxonomyには本関数が受け取った値が格納されている。
$_term = apply_filters( "get_$taxonomy", $_term, $taxonomy );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/taxonomy.php

最終更新 : 2019年03月15日 10:22



お勧め

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

親子の固定ページで同じテンプレートを使う(2013年3月20日 更新)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。