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



お勧め

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧(2018年5月27日 更新)

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Login rebuilder 2.4.0の新機能を紹介(2018年5月27日 更新)

昨日、約半年ぶりにLogin rebuilderをアップデートし、著者ページ(author page)の閲覧を制限できる機能を追加した。この機能は、著者ページの閲覧によってユーザーIDが類推されることを防ぐことが目的としている。

ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。