delete_comment_meta()WP 2.9.0

Remove metadata matching criteria from a comment.

You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.

No Hooks.

Return

true|false. True on success, false on failure.

Usage

delete_comment_meta( $comment_id, $meta_key, $meta_value );
$comment_id(int) (required)
Comment ID.
$meta_key(string) (required)
Metadata name.
$meta_value(mixed)
Metadata value. If provided, rows will only be removed that match the value. Must be serializable if non-scalar.
Default: empty string

Examples

0

#1 Delete all comment metadata with the key my_meta_key

delete_comment_meta( 5, 'my_meta_key' );
0

#2 Delete comment metadata with my_meta_key and foo value

delete_comment_meta( 5, 'my_meta_key', 'foo' );

Changelog

Since 2.9.0 Introduced.

delete_comment_meta() code WP 6.5.2

function delete_comment_meta( $comment_id, $meta_key, $meta_value = '' ) {
	return delete_metadata( 'comment', $comment_id, $meta_key, $meta_value );
}