delete_term_meta() の使い方|説明・引数・注意点

説明

delete_term_meta() は、タームのメタデータを削除する関数です。

基本構文

delete_term_meta( int $term_id, string $meta_key, mixed $meta_value = '' ): bool

引数

  • $term_id:タームID
  • $meta_key:メタキー
  • $meta_value:値(省略可)

戻り値

削除できたら true。

使い方(サンプル)

delete_term_meta( 5, 'color' );

注意点

  • 値を省略するとそのキーが全て消えます。

実務での使いどころ

  • タームのメタを、削除するとき。

よくあるミスと対処

  • $meta_value を指定せず、同じキーのすべての値を削除してしまう。
  • 存在しないキーの削除では、false が返る。

NG例

delete_term_meta( $term_id, 'color' ); // 同じキーのすべての値が、削除される

OK例

delete_term_meta( $term_id, 'color', 'red' ); // 'red' の値だけを削除

使い分け早見表

関数 役割
delete_term_meta() 値を削除する
update_term_meta() 値を保存する
get_term_meta() 値を取得する

関連項目

get_term_meta()、update_term_meta()

公式リファレンス:delete_term_meta() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました