説明
パラメータ
バージョン4.5.0以降のパラメータは次の通り。
- $args検索条件を指定する文字列または連想配列。主なキーワードは次の通り。
キーワード 意味 taxonomy タクソノミーを示すcategory、post_tagなど 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 取得したいタクソノミーのスラッグを指定 hierarchical true(1)またはfalse(0)を指定(省略時はtrue) search 取得したいタクソノミーの名前(その一部)を指定 name__like 取得したいタクソノミーの名前の先頭部分を指定 pad_counts 子タクソノミーの投稿件数を親タクソノミーに加算する場合はtrue(1)を指定(省略時はfalse) get すべてのカテゴリー情報を取得する場合にallを指定 child_of カテゴリーのIDを指定(そのIDのタクソノミーの子孫がすべて対象となる) parent カテゴリーのIDを指定(そのIDのタクソノミーの子カテゴリーのみが対象となる) suppress_filter [4.8.0]フィルター処理しない場合はtrueを指定(省略時はfalse) - $deprecated非推奨(互換性維持のため存在)
バージョン4.4.3以前のパラメータは次の通り。
- $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 取得したいタクソノミーのスラッグを指定 hierarchical true(1)またはfalse(0)を指定(省略時はtrue) search 取得したいタクソノミーの名前(その一部)を指定 name__like 取得したいタクソノミーの名前の先頭部分を指定 pad_counts 子タクソノミーの投稿件数を親タクソノミーに加算する場合はtrue(1)を指定(省略時はfalse) get すべてのカテゴリー情報を取得する場合にallを指定 child_of カテゴリーのIDを指定(そのIDのタクソノミーの子孫がすべて対象となる) parent カテゴリーのIDを指定(そのIDのタクソノミーの子カテゴリーのみが対象となる)
返り値
マッチしたすべてのデータが格納された配列を返す。タクソノミー情報のメンバー変数は次の通り。プロパティ名 | データ型 | 意味 |
---|---|---|
term_id | int | ID |
name | string | 名前 |
slug | string | スラッグ |
term_group | int | グループID |
term_taxonomy_id | int | タクソノミーID |
taxonomy | string | タクソノミー名 |
description | string | 説明 |
parent | int | 親タクソノミーのID。親タクソノミーがない場合は0となる |
count | int | 投稿数 |
注意
タクソノミー情報は、投稿記事の付随情報のことで、カテゴリーや投稿タグなどが含まれている。 get_categoriesや get_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.5.0]パラメータの仕様が変更となり、基本的に第1パラメータのみを使用するようになった(ただし、互換性維持のためそれ以前のパラメータでも動作している)。
[4.6.0]検索機能を備えたWP_Term_Queryクラスの登場により、'get_terms'以外のフィルターはそちらに移動。'get_terms'フィルターのパラメータに検索に使用したWP_Term_Queryオブジェクトが追加された。
[4.8.0]suppress_filterが追加され、get_termsフィルターの処理前の内容を取得できるようになった。
使用例
- すべてのカテゴリー情報を取得する。
<?php // 4.5.0以降 $categories = get_terms( array( 'taxonomy'=>'category', 'get'=>'all' ) ); // 4.4.3以前 $categories = get_terms( 'category', 'get=all' ) ); ?>
- すべての投稿タグ情報を取得する。
<?php // 4.5.0以降 $tags = get_terms( array( 'taxonomy'=>'post_tag', 'get'=>'all' ) ); // 4.4.3以前 $tags = get_terms( 'post_tag', 'get=all' ) ); ?>
フィルター
[4.4.0]パラメータ$argsとマージする前にデフォルトのクエリー条件を調整する'get_terms_defaults'フィルターを呼び出す。パラメータ$defaultsにはデフォルトのクエリー条件(連想配列)が、$taxonomiesには本関数が受け取った内容がfalseが格納される。アクション
実行するアクションはありません。ソースファイル
/wp-includes/taxonomy.php最終更新 : 2020年12月14日 16:32
関連
お勧め
5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)
「5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。
ログインページのタイトルを変更してみる(2018年5月27日 更新)
バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。
プラグインで注意が必要な関数(2013年11月27日 更新)
先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。
ブロックエディターの色設定を変えてみる(2019年12月11日 更新)
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。