get_terms

(2.3.0以降)
get_terms - タクソノミー情報を取得する

説明

array get_terms( mixed $taxonomies, [ mixed $args = '' ] )
条件を指定してタクソノミー情報を検索し、マッチしたすべてのデータを取得する。

パラメータ

  • $taxonomies
    タクソノミー名。複数指定する場合は配列で指定。
    タクソノミー名意味
    categoryカテゴリー
    post_tag投稿タグ
    nav_menuメニュー
    link_categoryリンクのカテゴリー
  • $args
    検索条件を指定する文字列または連想配列。主なキーワードは次の通り。
    キーワード意味
    orderbyソート対象を示すcount、name、slug、term_group、none、idなど(省略時は'name')
    orderソート順を示すASCかDESC(省略時はASC)
    hide_empty投稿記事がないタクソノミーを取得しない場合はtrue(1)、投稿記事がないタクソノミーも取得する場合はfalse(0)を指定(省略時はtrue)
    exclude取得したくないタクソノミーのID(複数指定する場合は,で区切る)
    exclude_tree取得したくないタクソノミーのID(複数指定する場合は,で区切る)。指定されたIDのタクソノミーが子タクソノミーを持っている場合、それらの子カテゴリーも除外される。
    include取得したいタクソノミーのID(複数指定する場合は,で区切る)
    number取得件数(省略時は条件にマッチするすべてを取得する)
    offset取得開始位置(省略時は0:先頭)
    fields情報項目を示すall、count、ids、namesなどを指定(省略時はall)
    slug取得したいタクソノミーのスラッグを指定
    hierarchicaltrue(1)またはfalse(0)を指定(省略時はtrue)
    search取得したいタクソノミーの名前(その一部)を指定
    name__like取得したいタクソノミーの名前の先頭部分を指定
    pad_counts子タクソノミーの投稿件数を親タクソノミーに加算する場合はtrue(1)を指定(省略時はfalse)
    getすべてのカテゴリー情報を取得する場合にallを指定
    child_ofカテゴリーのIDを指定(そのIDのタクソノミーの子孫がすべて対象となる)
    parentカテゴリーのIDを指定(そのIDのタクソノミーの子カテゴリーのみが対象となる)

返り値

マッチしたすべてのデータが格納された配列を返す。タクソノミー情報のメンバー変数は次の通り。
プロパティ名データ型意味
term_idintID
namestring名前
slugstringスラッグ
term_groupintグループID
term_taxonomy_idintタクソノミーID
taxonomystringタクソノミー名
descriptionstring説明
parentint親タクソノミーのID。親タクソノミーがない場合は0となる
countint投稿数

注意

タクソノミー情報は、投稿記事の付随情報のことで、カテゴリーや投稿タグなどが含まれている。get_categoriesget_tagsでは、このget_termsを使用して情報を取得している。
パラメータ$argsで指定する検索条件はデフォルトでは'hide_empty'がtrueのため、投稿のないタクソノミーは取得できない。投稿数に関係なくすべてのカテゴリー情報を取得する場合は、'get=all'を指定するのが便利。
なお'parent'が指定された場合は、'child_of=0'、'hierarchical=false'、'pad_counts=false'へと強制的に変更される。
また'get=all'が指定された場合は、'child_of=0'、'hide_empty=0'、'hierarchical=false'、'pad_counts=false'へと強制的に変更される。

[4.6.0]検索機能を備えたWP_Term_Queryクラスの登場により、'get_terms'以外のフィルターはそちらに移動。'get_terms'フィルターのパラメータに検索に使用したWP_Term_Queryオブジェクトが追加された。

使用例

  • すべてのカテゴリー情報を取得する。
    <?php $categories = get_terms( 'category', 'get=all' ) ); ?>
  • すべての投稿タグ情報を取得する。
    <?php $tags = get_terms( 'post_tag', 'get=all' ) ); ?>

フィルター

[4.4.0]パラメータ$argsとマージする前にデフォルトのクエリー条件を調整する'get_terms_defaults'フィルターを呼び出す。パラメータ$defaultsにはデフォルトのクエリー条件(連想配列)が、$taxonomiesには本関数が受け取った内容がfalseが格納される。
$args = wp_parse_args( $args, apply_filters( 'get_terms_defaults', $defaults, $taxonomies ) );
[3.1.0]パラメータ$argsの初期値を調整するために'get_terms_args'フィルターを呼び出す。パラメータ$args$taxonomiesには本関数が受け取った内容が格納される。
$args = apply_filters( 'get_terms_args', $args, $taxonomies );
[2.8.0]ソート対象を確定するために'get_terms_orderby'フィルターを呼び出す。パラメータ$orderbyはソート対象、$taxonomiesは本関数が受け取った内容が、$argsはフィルター処理済みの内容が格納される。
$orderby = apply_filters( 'get_terms_orderby', $orderby, $args, $taxonomies );
[2.3.0]除外するターム情報を確定するために'list_terms_exclusions'フィルターを呼び出す。パラメータ$exclusionsは除外する条件文、$taxonomiesは本関数が受け取った内容が、$argsはフィルター処理済みの内容が格納される。
$exclusions = apply_filters( 'list_terms_exclusions', $exclusions, $args, $taxonomies );
[2.8.0]ターム情報の取得する項目を確定するために'get_terms_fields'フィルターを呼び出す。パラメータ$selectsは項目の配列、$taxonomiesは本関数が受け取った内容が、$argsはフィルター処理済みの内容が格納される。
$selects = apply_filters( 'get_terms_fields', $selects, $args, $taxonomies );
[3.1.0]ターム情報の取得前に'terms_clauses'フィルターを呼び出す。パラメータ$clausesは検索項目の連想配列、$taxonomiesは本関数が受け取った内容が、$argsはフィルター処理済みの内容が格納される。
$clauses = apply_filters( 'terms_clauses', $clauses, $taxonomies, $args );
[2.3.0]ターム情報の配列を返す直前に'get_terms'フィルターを呼び出す。パラメータ$termsはターム情報の配列、$taxonomiesは本関数が受け取った内容が、$argsはフィルター処理済みの内容が格納される。[4.6.0]パラメータ$term_queryが追加され、検索に使用したWP_Term_Queryオブジェクトが格納される。
$terms = apply_filters( 'get_terms', $terms, $taxonomies, $args );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/taxonomy.php

関連

お勧めコンテンツ

「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 登録)

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

各投稿記事で設定されているカスタムフィールドの値を取得するには(2011年9月16日 登録)

投稿記事ごとに設定されているカスタムフィールドの値はget_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 登録)

WordPress 3.5で登場するであろうWP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

日本語が含まれていないコメントを無効化する(2012年1月31日 登録)

日本のユーザーを対象にサービス(情報)展開しているサイトの場合、英文のみのコメントはあまりうれしくない。ましてやスパムコメントの対応は時間の無駄でしかない。そんなわけで、日本語を含んでいないコメントを無効化することにした。

投稿ページにキーワード検索ウィジェットを追加する(2012年6月2日 登録)

「投稿の編集」ページで記事を編集していると、関連する投稿記事を検索したくなることがある。そんな時、「投稿一覧」ページに戻って「キーワード検索」を行えばいいのだが、そのひと手間がちょっとだけ煩わしい。

最終更新日時 : 2016-08-19 17:19