説明
delete_post_meta() は、投稿のメタデータを削除する関数です。
基本構文
delete_post_meta( int $post_id, string $meta_key, mixed $meta_value = '' ): bool
引数
$post_id:投稿ID$meta_key:メタキー$meta_value:値を指定すると、一致するもののみ削除
戻り値
削除できたら true。
使い方(サンプル)
delete_post_meta( 123, 'price' );
注意点
- 値を指定しないと、そのキーのメタがすべて削除されます。
実務での使いどころ
- カスタムフィールドの値を、削除するとき。
- 同じキーの、特定の値だけを削除するとき(
$meta_valueを指定)。
よくあるミスと対処
$meta_valueを指定せず、同じキーのすべての値を削除してしまう。- 存在しないキーの削除では、
falseが返る。 - 削除前に、権限の確認をしていない。
NG例
delete_post_meta( $post_id, 'tag' ); // 同じキーのすべての値が、削除される
OK例
delete_post_meta( $post_id, 'tag', 'php' ); // 'php' の値だけを削除
使い分け早見表
| 関数 | 役割 |
|---|---|
delete_post_meta() |
値を削除する |
update_post_meta() |
値を保存する |
add_post_meta() |
値を追加する |
関連項目
get_post_meta()、update_post_meta()
公式リファレンス:delete_post_meta() | Function | WordPress Developer Resources

コメント