On this page
update_comment_meta( int $comment_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ): int|bool
Updates comment meta field based on comment ID.
Description
Use the $prev_value parameter to differentiate between meta fields with the same key and comment ID.
If the meta field for the comment does not exist, it will be added.
Parameters
$comment_idint Required-
Comment ID.
$meta_keystring Required-
Metadata key.
$meta_valuemixed Required-
Metadata value. Must be serializable if non-scalar.
$prev_valuemixed Optional-
Previous value to check before updating.
If specified, only update existing metadata entries with this value. Otherwise, update all entries.Default:
''
Return
int|bool Meta ID if the key didn't exist, true on successful update, false on failure or if the value passed to the function is the same as the one that is already in the database.
Source
File: wp-includes/comment.php. View all references
function update_comment_meta( $comment_id, $meta_key, $meta_value, $prev_value = '' ) {
return update_metadata( 'comment', $comment_id, $meta_key, $meta_value, $prev_value );
}
Related
Uses
| Uses | Description |
|---|---|
| update_metadata() wp-includes/meta.php | Updates metadata for the specified object. If no value already exists for the specified object ID and metadata key, the metadata will be added. |
Used By
| Used By | Description |
|---|---|
| wp_update_comment() wp-includes/comment.php | Updates an existing comment in the database. |
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/update_comment_meta