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日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

さくらのVPSでKUSANAGI#3(2018年5月27日 更新)

今回は「前回」の続き。http(80番)をクローズ、そのほかに行った調整作業について整理する。