get_term

（2.3.0以降）
get_term - IDを指定してカテゴリー・タグ情報を取得する

説明

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

関連

参考

Code Reference: get_term

お勧め

テキストエディタの文字を変更する（2018年5月27日 更新）

テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

更新ボタンの横にスピナーを実装する（2019年5月14日 更新）

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

公式ディレクトリに登録するならajax.googleapis.comのライブラリは利用しない（2018年5月27日 更新）

数日前、投稿一覧ページの絞り込みドロップダウンメニューを複数選択可能にするプラグイン「Posts filter multiselect」を公開したのですが、その際に指摘されたポイントを紹介します。

Login rebuilder 2.3.0の新機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。