update_comment_meta

Advertisement

Summery Summery

Update comment meta field based on comment ID.

Syntax Syntax

update_comment_meta( int $comment_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )

Description 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 Parameters

$comment_id

(int) (Required) Comment ID.

$meta_key

(string) (Required) Metadata key.

$meta_value

(mixed) (Required) Metadata value.

$prev_value

(mixed) (Optional) Previous value to check before removing.

Default value: ''

Return Return

(int|bool) Meta ID if the key didn't exist, true on successful update, false on failure.

Source Source

File: wp-includes/comment.php

 *
 * @since 2.9.0
 *

Advertisement

Changelog Changelog

Changelog
Version Description
2.9.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.