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.


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.

Top ↑


$comment_id int Required
Comment ID.
$meta_key string Required
Metadata key.
$meta_value mixed Required
Metadata value. Must be serializable if non-scalar.
$prev_value mixed Optional
Previous value to check before updating.
If specified, only update existing metadata entries with this value. Otherwise, update all entries.

Default: ''

Top ↑


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.

Top ↑


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

Top ↑


Version Description
2.9.0 Introduced.

Top ↑

User Contributed Notes

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