delete_comment_meta() の説明と使用例

WordPressの関数delete_comment_meta()は、特定のコメントに関連付けられたメタデータを削除するために使用されます。

構文

delete_comment_meta( int $comment_id, string $meta_key, mixed $meta_value = '' );

引数の説明:

$comment_id (int) — コメントのIDを指定します。
$meta_key (string) — 削除するメタデータのキーを指定します。
$meta_value (mixed) — (オプション) 指定された値と一致するメタデータだけを削除します。デフォルトは空文字列。

注意点:

指定されたコメントIDが存在しない場合、この関数は何も行いません。
$meta_valueを省略すると、指定されたキーに関連付けられたすべてのメタデータが削除されます。

例 1: 特定のコメントのメタデータを削除

コメントIDがget_comment_ID()によって返されるコメントから、キーが'example_key'のメタデータを削除します。

delete_comment_meta( get_comment_ID(), 'example_key' );

例 2: 特定の値を持つメタデータのみ削除

コメントIDがget_comment_ID()のコメントから、キーが'example_key'かつ値が'example_value'のメタデータを削除します。

delete_comment_meta( get_comment_ID(), 'example_key', 'example_value' );

例 3: カスタムコメントメタデータの初期化

特定のコメントIDに関連するすべてのカスタムメタデータをクリアします。

delete_comment_meta( get_comment_ID(), 'custom_meta_key' );

例 4: コメントメタデータの条件付き削除

メタデータが特定の条件を満たす場合のみ削除します。

if ( get_comment_meta( get_comment_ID(), 'example_key', true ) === 'delete_this_value' ) {
    delete_comment_meta( get_comment_ID(), 'example_key' );
}

例 5: 全コメントのメタデータをループ内で削除

すべてのコメントのメタデータ'example_key'を削除します。

$comments = get_comments();
foreach ( $comments as $comment ) {
    delete_comment_meta( $comment->comment_ID, 'example_key' );
}

構文