get_term:WordPress私的マニュアル

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_id	int	ID
name	string	名前
slug	string	スラッグ
term_group	int	グループID
term_taxonomy_id	int	タクソノミーID
taxonomy	string	タクソノミー名。カテゴリーの場合は'category'、タグの場合は'post_tag'となる
description	string	説明
parent	int	親カテゴリーID。親カテゴリーがない場合は0となる
count	int	投稿数

注意

返り値は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

参考

Code Reference: get_term

参考

WordPressでタグ別記事一覧を表示する方法 | [ゆめみち]

get_term

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

参考

お勧めコンテンツ