delete_user_meta() の使い方｜説明・引数・注意点

説明

基本構文

delete_user_meta( int $user_id, string $meta_key, mixed $meta_value = '' ): bool

引数

• $user_id：ユーザーID
• $meta_key：メタキー
• $meta_value：値（省略可）

戻り値

削除できたら true。

使い方（サンプル）

delete_user_meta( 1, 'phone' );

注意点

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

実務での使いどころ

• ユーザーのメタを、削除するとき。
• ユーザーを削除する前後に、独自のメタを掃除するとき。

よくあるミスと対処

• $meta_value を指定せず、同じキーのすべての値を削除してしまう。
• 存在しないキーの削除では、false が返る。
• 権限の確認なしに、他のユーザーのメタを削除している。

NG例

delete_user_meta( $user_id, 'favorite' ); // 同じキーのすべての値が、削除される

OK例

delete_user_meta( $user_id, 'favorite', 'php' ); // 'php' の値だけを削除

使い分け早見表

関連項目

get_user_meta()、update_user_meta()

公式リファレンス：delete_user_meta() | Function | WordPress Developer Resources