W3cubDocs

/WordPress

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

Remove metadata matching criteria from a comment.

Description

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.

Parameters

$comment_id

(int) (Required) Comment ID.

$meta_key

(string) (Required) Metadata name.

$meta_value

(mixed) (Optional) Metadata value. If provided, rows will only be removed that match the value. Must be serializable if non-scalar.

Default value: ''

Return

(bool) True on success, false on failure.

Source

File: wp-includes/comment.php 

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

Uses

Uses Description
wp-includes/meta.php: delete_metadata()

Deletes metadata for the specified object.

Used By

Used By Description
wp-includes/functions.php: wp_scheduled_delete()

Permanently delete comments or posts of any type that have held a status of ‘trash’ for the number of days defined in EMPTY_TRASH_DAYS.
wp-includes/comment.php: wp_spam_comment()

Marks a comment as Spam
wp-includes/comment.php: wp_unspam_comment()

Removes a comment from the Spam
wp-includes/comment.php: wp_trash_comment()

Moves a comment to the Trash
wp-includes/comment.php: wp_untrash_comment()

Removes a comment from the Trash

Changelog

Version Description
2.9.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/delete_comment_meta