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

関連

お勧めコンテンツ

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 登録)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

初期化に関連するアクションのおさらい(2012年8月7日 登録)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

テーマから投稿画像のサイズを指定する(2012年3月15日 登録)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

カスタムフィールドで並び替え(2013年8月9日 登録)

WordPressでは複数の投稿記事を取得する際、並び順の指定を省略すると投稿日時の降順になる。並び順は、投稿日時だけでなく、更新日時、投稿名、記事タイトル、コメント数のほか、カスタムフィールドも指定できる。

プラグインで注意が必要な関数(2013年11月27日 登録)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

最終更新日時 : 2016-05-22 22:45