delete_comment_meta() WordPress Function
The delete_comment_meta() function can be used to delete comment meta data for a given comment. This function takes two arguments: the ID of the comment for which you want to delete comment meta data, and the key of the comment meta data you want to delete.
delete_comment_meta( int $comment_id, string $meta_key, mixed $meta_value = '' ) #
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.
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 );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |