概要
get_term_meta関数は、WordPressにおいてタームのメタ情報を取得するための関数です。この関数は特にカスタムタクソノミーやカテゴリ、タグなど、タームに関連する追加情報を管理する際に用いられます。以下のような場合に頻繁に使用されます。
- タームの追加情報を取得する
- カスタム設定をタームに関連付ける
- ターム一覧をカスタマイズする
- タームに関連したデータの表示を行う
- プラグインやテーマの設定をタームに基づいて変更する
- 特定のタームにだけ関連するメタ情報を取得する
- タームの表示を動的に変更する
- タームに関連するデータの保存と取得を行う
構文
get_term_meta( $term_id, $meta_key, $single );
パラメータ
$term_id(int) – メタ情報を取得したいタームのID。$meta_key(string) – 取得したいメタ情報のキー。$single(bool) – trueを指定すると、メタ情報は単一の値として返されます。falseの場合は配列で返されます。
戻り値
- 指定されたタームのメタ情報。指定されたキーが存在しない場合、空の値または配列が返されます。
関連する関数
使用可能なバージョン
get_term_meta関数は、WordPress 4.4以降で利用可能です。
コアファイルのパス
wp-includes/taxonomy.php
サンプルコード
サンプルコード1: タームのメタ情報を取得する基本例
$term_id = 1; // タームIDを指定
$meta_key = 'custom_meta_key'; // メタキーを指定
$meta_value = get_term_meta($term_id, $meta_key, true);
echo $meta_value; // メタ情報を出力
このサンプルコードは、指定したタームIDのカスタムメタ情報を取得し、出力します。
サンプルコード2: 複数のメタ情報を取得する
$term_id = 1;
$meta_key = 'custom_meta_key';
$meta_values = get_term_meta($term_id, $meta_key, false); // 配列として取得
foreach ($meta_values as $value) {
echo $value . '<br>'; // 各メタ情報を出力
}
このコードは、指定したメタキーに関連するすべてのメタ情報を配列形式で取得し、それぞれを出力します。
サンプルコード3: メタ情報が存在するか確認する
$term_id = 1;
$meta_key = 'custom_meta_key';
$meta_value = get_term_meta($term_id, $meta_key, true);
if (!empty($meta_value)) {
echo 'メタ情報は存在します: ' . $meta_value;
} else {
echo 'メタ情報は存在しません';
}
このサンプルコードは、指定したタームのメタ情報が存在するかどうかチェックし、出力を行います。
サンプルコード4: デフォルト値を使用
$term_id = 1;
$meta_key = 'custom_meta_key';
$meta_value = get_term_meta($term_id, $meta_key, true);
$default_value = 'デフォルト値';
if (empty($meta_value)) {
$meta_value = $default_value; // メタ情報が見つからない場合のデフォルト値
}
echo $meta_value;
このコードは、タームのメタ情報が存在しない場合にデフォルト値を出力します。
サンプルコード5: タームの追加情報をHTMLで表示
$term_id = 1;
$meta_key = 'custom_meta_key';
$meta_value = get_term_meta($term_id, $meta_key, true);
if ($meta_value) {
echo '<div class="meta-info">メタ情報: ' . esc_html($meta_value) . '</div>';
}
このサンプルコードは、取得したメタ情報をHTMLのdiv要素内で安全に表示します。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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_meta関数は、現時点で非推奨または削除されたWordPressのバージョンはありません。