概要
add_term_meta関数は、特定のタームに対してメタ情報を追加するための機能を提供します。この関数は、カスタムタクソノミーやカテゴリ、タグなど、タームに関連する追加のデータを保存する際に広く使用されます。以下は、add_term_meta関数がよく使用されるケースの一例です。
- カスタムタクソノミーに関連する情報の管理
- タームに関する設定情報の追加
- ターム特有のメタデータの保存
- プラグインがタームに対してカスタム情報を格納する際
- タームの表示に必要なカスタムフィールドの保存
- タームの権限やステータスに関連する情報の管理
- タームの SEO 設定情報の保存
- ターム関連の統計データの保存
構文
add_term_meta( int $term_id, string $meta_key, mixed $meta_value, bool $unique = false );
パラメータ
term_id: メタデータを追加するタームのID（整数）meta_key: メタデータのキー（文字列）meta_value: メタデータの値（任意の型）unique: 同じキーのメタデータがすでに存在する場合に新しいメタデータを追加するかどうか（真偽値、デフォルトはfalse）
戻り値
- 成功した場合は新しく追加されたメタIDを返し、失敗した場合はfalseを返します。
関連する関数
使用可能なバージョン
add_term_meta関数はWordPress 4.4.0以降で使用可能です。
コアファイルのパス
この関数は、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 |
サンプルコード
以下に、add_term_meta関数の使用例を5つ示します。
サンプルコード 1
$term_id = wp_insert_term('新しいターム', 'category');
$added = add_term_meta($term_id['term_id'], 'custom_meta_key', 'カスタムメタ値');
このコードは、新しいカテゴリタームを作成し、そのタームにカスタムメタ情報を追加します。
サンプルコード 2
$term_id = 123; // 既存のタームID
$added = add_term_meta($term_id, 'another_meta_key', '別のメタ値', true);
このコードは、指定したタームIDにユニークなカスタムメタ値を追加します。もし同じキーが存在した場合は追加されません。
サンプルコード 3
$term_id = 456; // 既存のタームID
$success = add_term_meta($term_id, 'status', 'active');
if ($success) {
echo 'メタデータが正常に追加されました。';
}
このコードは、特定のタームに対してステータスメタデータを追加し、成功した場合にはメッセージを表示します。
サンプルコード 4
$term_name = 'ターム名';
$term_id = wp_insert_term($term_name, 'post_tag');
add_term_meta($term_id['term_id'], 'description', 'このタームの説明');
このコードは、新しいタグタームを作成し、その説明メタデータを追加します。
サンプルコード 5
$term_id = 789; // 既存のタームID
$added_meta = add_term_meta($term_id, 'views', 100);
このコードは、特定のタームに対して「views」というカスタムメタ情報を追加し、表示回数の管理に役立てます。