説明
mixed get_term_by( string $field , mixed $value , string $taxonomy [ , string $output = OBJECT [ , string $filter = 'raw' ] ] )
ID、名前、スラッグを指定してカテゴリー・タグ情報を取得する。
パラメータ
- $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
関連
お勧め
任意の名前でエラーログファイルを指定する(2019年2月15日 更新)
来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。
Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)
カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。テキストエディタの文字を変更する(2018年5月27日 更新)
テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。