概要
get_term_by関数は、指定された条件に基づいてタクソノミー用語（カテゴリーやタグなど）の情報を取得するための関数です。この関数は、WordPress内でのタクソノミーの操作に便利であり、以下のような機能を実装する際によく使用されます。
- タグやカテゴリーの詳細情報を取得
- タクソノミータームのスラッグを基準にデータベースから情報を引き出す
- タームIDを利用して他の情報と関連づける
- タクソノミーに属する特定のタームを確認する
- コンテンツに基づく動的なメタ情報の表示
- カスタムタクソノミー用語の管理
- SEO対策としてのターム情報挿入
- フロントエンドでのタクソノミー情報のカスタマイズ
構文
get_term_by( $field, $value, $taxonomy, $output = OBJECT, $filter = 'raw' );
パラメータ
$field(string): 検索するフィールドの種類。'id','slug','name'のいずれか。$value(string|int): 検索する値。$taxonomy(string): タクソノミーの名前。$output(string): 戻り値のフォーマット。OBJECT,ARRAY_A,ARRAY_Nのいずれか。デフォルトはOBJECT。$filter(string): フィルタリングのオプション。デフォルトは'raw'。
戻り値
get_term_by関数は、指定されたタクソノミー用語が見つかった場合、そのタームのオブジェクトを返します。見つからなかった場合はnullを返します。
関連する関数
使用可能なバージョン
この関数はWordPress 2.3.0以降で利用可能です。
コアファイルのパス
get_term_by関数はwp-includes/taxonomy.phpに含まれています。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | 〇 |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | 〇 |
| after_setup_theme | 〇 |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | 〇 |
| wp | 〇 |
| template_redirect | 〇 |
| get_header | |
| wp_head | 〇 |
get_term_by関数は、特定のバージョンで非推奨または削除されているわけではありません。