WordPress at Your Fingertips

delete_comment_meta() WP 1.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: ''

Changelog

Since 2.9.0 Introduced.

Code of delete_comment_meta() WP 5.8.1

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

Metadatas (any)

No comments
    Log In