説明
パラメータ
- $field検索する値のフィールド名を示す'slug'、'name'、'id'、'term_taxonomy_id'など。なお、'slug'または'name'以外はIDとして解釈される。
- $value検索する値。
- $taxonomyタクソノミー名を示す'category'、'post_tag'、'link_category'の何れか。
- $output出力型を示すOBJECT、ARRAY_A、ARRAY_Nの何れか(省略時はOBJECT)。
- $filterフィルター名(省略時は'raw')。
返り値
カテゴリー・タグが見つかった場合はそのカテゴリー・タグ情報をパラメータ$outputで指定された型で返す。カテゴリー・タグが見つからなかった場合はfalseを返す。 $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 | 投稿数 |
注意
パラメータ$outputの値は、決められた定数(OBJECT、ARRAY_A、ARRAY_N)以外は無効となる。
[4.4.0]パラメータ$fieldが'term_taxonomy_id'の場合、パラメータ$taxonomyは省略可能。パラメータ$outputがOBJECTの場合、WP_Termオブジェクトを返すように変更された。
[5.5.0]パラメータ$fieldに'ID'が指定可能になった('id'のエイリアス)。
使用例
- スラッグが'blog'のカテゴリー情報を取得する。<?php $cat = get_term_by( 'slug' , 'blog' , 'category' ); ?>
フィルター
直接実行するフィルターはありません。アクション
直接実行するアクションはありません。ソースファイル
/wp-includes/taxonomy.php最終更新 : 2020年08月28日 14:06
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。