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.

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 );
}

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