add_term_meta()


WordPressの関数add_term_meta()は、特定のタクソノミータームにメタデータを追加するために使用されます。この関数を使用することで、タームに追加情報を付与できます。

構文

add_term_meta( int $term_id, string $meta_key, mixed $meta_value, bool $unique = false );

引数の説明:

  • $term_id (int) — メタデータを追加するタームのID。
  • $meta_key (string) — メタデータのキー。ユニークな名前を指定。
  • $meta_value (mixed) — 保存するメタデータの値。
  • $unique (bool) — 同じキーの値を複数許可するかどうか。デフォルトはfalse。

例 1: タームにカスタムメタデータを追加

特定のタームにカスタムフィールドを追加する基本的な例です。

add_term_meta( get_term_by( 'slug', 'example-term', 'category' )->term_id, 'custom_field', 'value' );

例 2: 一意のメタデータを追加

同じキーが存在しない場合にのみメタデータを追加します。

add_term_meta( get_term_by( 'slug', 'example-term', 'category' )->term_id, 'unique_field', 'unique_value', true );

例 3: タームメタのキーと値を設定

meta_keyを使って複数の値を同じタームに追加します。

add_term_meta( get_term_by( 'slug', 'example-term', 'category' )->term_id, 'custom_key', 'first_value' );
add_term_meta( get_term_by( 'slug', 'example-term', 'category' )->term_id, 'custom_key', 'second_value' );

例 4: カスタムタクソノミーで使用

カスタムタクソノミーのタームにメタデータを追加します。

add_term_meta( get_term_by( 'name', 'Custom Term', 'custom_taxonomy' )->term_id, 'meta_key', 'meta_value' );

例 5: フロントエンドで条件付き表示

条件に基づいてタームメタを取得し、表示します。

$term_id = get_term_by( 'slug', 'example-term', 'category' )->term_id;
if ( add_term_meta( $term_id, 'custom_field', 'value' ) ) {
    echo 'メタデータが正常に追加されました。';
}

注意事項

  • すでに同じキーが存在している場合、$uniqueをtrueに設定するとエラーになる可能性があります。
  • 保存されたデータを適切にエスケープおよびサニタイズする必要があります。

関連機能：