delete_comment_meta( int $comment_id, string $meta_key, mixed $meta_value ): bool

Removes 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.

For historical reasons both the meta key and the meta value are expected to be “slashed” (slashes escaped) on input.

Parameters

$comment_idintrequired: Comment ID.
$meta_keystringrequired: Metadata name.
$meta_valuemixedoptional: Metadata value. If provided, rows will only be removed that match the value.
Must be serializable if non-scalar. Default empty string.

Return

bool True on success, false on failure.

Source

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

View all references View on Trac View on GitHub

Uses	Description
delete_metadata()`wp-includes/meta.php`	Deletes metadata for the specified object.

Used by	Description
wp_scheduled_delete()`wp-includes/functions.php`	Permanently deletes comments or posts of any type that have held a status of ‘trash’ for the number of days defined in EMPTY_TRASH_DAYS.
wp_spam_comment()`wp-includes/comment.php`	Marks a comment as Spam.
wp_unspam_comment()`wp-includes/comment.php`	Removes a comment from the Spam.
wp_trash_comment()`wp-includes/comment.php`	Moves a comment to the Trash
wp_untrash_comment()`wp-includes/comment.php`	Removes a comment from the Trash

Changelog

Version	Description
2.9.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Delete all metadata with the key ‘my_meta_key’ for comment ID 5.
```
delete_comment_meta( 5, 'my_meta_key' );
```
Delete metadata for ‘my_meta_key’ only where the meta_value is ‘foo’.
```
delete_comment_meta( 5, 'my_meta_key', 'foo' );
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.