acf_delete_metadata()


ACF（Advanced Custom Fields）プラグインのacf_delete_metadata()関数は、指定されたメタデータを削除するために使用されます。この関数は、カスタムフィールドやその他のメタデータをプログラム的に操作する際に便利です。

構文

acf_delete_metadata( string $type, int|string $id, string $name, bool $hidden = false );

引数の説明:

  • $type (string) — メタデータのタイプ（例: post, user, term, comment）。
  • $id (int|string) — メタデータが関連付けられているオブジェクトのID。
  • $name (string) — 削除するメタデータの名前。
  • $hidden (bool) — 非公開メタデータを削除する場合はtrue。

例 1: 投稿メタデータを削除する

以下のコードは、投稿のメタデータを削除します。

acf_delete_metadata( 'post', get_the_ID(), 'example_meta_key' );

例 2: ユーザーメタデータを削除する

以下のコードは、指定したユーザーのメタデータを削除します。

acf_delete_metadata( 'user', get_current_user_id(), 'user_meta_key' );

例 3: 非公開メタデータを削除する

$hidden引数をtrueに設定して非公開メタデータを削除します。

acf_delete_metadata( 'post', get_the_ID(), '_hidden_meta_key', true );

例 4: タクソノミーメタデータを削除する

以下のコードは、特定のタームに関連付けられたメタデータを削除します。

acf_delete_metadata( 'term', get_queried_object_id(), 'term_meta_key' );

例 5: コメントメタデータを削除する

以下のコードは、コメントのメタデータを削除します。

acf_delete_metadata( 'comment', $comment_id, 'comment_meta_key' );

注意事項

  • acf_delete_metadata()を使用する際は、適切な権限を持つユーザーで実行してください。
  • 削除したデータは復元できませんので、実行前にバックアップを取ることをお勧めします。

関連機能：