delete_post_meta()

関数の概要

delete_post_meta()は、WordPressで特定の投稿からメタデータ（カスタムフィールド）を削除するための関数です。指定したキーと一致するメタデータを削除します。この関数は、不要になったカスタムフィールドを削除する際に非常に便利です。

パラメータの説明

delete_post_meta()関数は3つのパラメータを受け取ります。

  1. $post_id (int, 必須): メタデータを削除する投稿のID。
  2. $meta_key (string, 必須): 削除するメタデータのキー。
  3. $meta_value (mixed, オプション): 削除するメタデータの値。指定した場合、この値と一致するメタデータだけが削除されます。指定しない場合、キーに一致するすべてのメタデータが削除されます。

使用例

以下は、delete_post_meta()関数を使用して投稿のメタデータを削除する例です。

<?php
// 投稿IDが42の投稿のカスタムフィールド 'subtitle' を削除する
$post_id = 42;
$meta_key = 'subtitle';

if (delete_post_meta($post_id, $meta_key)) {
    echo '<p>Subtitle meta data deleted successfully.</p>';
} else {
    echo '<p>Subtitle meta data deletion failed.</p>';
}

// 投稿IDが42の投稿のカスタムフィールド 'subtitle' の値が 'Old Subtitle' の場合のみ削除する
$meta_value = 'Old Subtitle';

if (delete_post_meta($post_id, $meta_key, $meta_value)) {
    echo '<p>Subtitle meta data with value "Old Subtitle" deleted successfully.</p>';
} else {
    echo '<p>Subtitle meta data deletion failed.</p>';
}
?>

関連する関数

  • add_post_meta(): 投稿に新しいメタデータを追加します。キーと値のペアを追加します。
  • get_post_meta(): 投稿のメタデータを取得します。特定のキーの値を取得します。
  • update_post_meta(): 既存のメタデータの値を更新します。キーと値のペアを更新します。
  • delete_metadata(): 汎用的なメタデータ削除関数で、投稿以外のメタデータにも使用できます。
  • delete_term_meta(): 用語（ターム）のメタデータを削除します。
  • delete_user_meta(): ユーザーのメタデータを削除します。