add_comment_meta( int $comment_id, string $meta_key, mixed $meta_value, bool $unique = false ): int|false

Description

Parameters

$comment_idint

Comment ID.

$meta_keystring

Metadata name.

$meta_valuemixed

Metadata value. Arrays and objects are stored as serialized data and will be returned as the same type when retrieved. Other data types will be stored as strings in the database: - false is stored and retrieved as an empty string ('') - true is stored and retrieved as '1' - numbers (both integer and float) are stored and retrieved as strings Must be serializable if non-scalar.

$uniquebooloptional

Whether the same key should not be added. Default false.Default: false

Return

int|false

Meta ID on success, false on failure.

Uses · 1

• add_metadata()Adds metadata for the specified object.

Used by · 3

• wp_insert_comment()Inserts a comment into the database.
• wp_spam_comment()Marks a comment as Spam.
• wp_trash_comment()Moves a comment to the Trash

Source

View on Trac ↗View on GitHub ↗

471function add_comment_meta( $comment_id, $meta_key, $meta_value, $unique = false ) {472	return add_metadata( 'comment', $comment_id, $meta_key, $meta_value, $unique );473}

History

Introduced in 2.9.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/comment.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.