wp_insert_comment( array $commentdata ): int|false

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$commentdataarray

Array of arguments for inserting a new comment.

• $comment_agentstringdefault: empty

  The HTTP user agent of the $comment_author when the comment was submitted.

• $comment_approvedint|stringdefault: 1

  Whether the comment has been approved.

• $comment_authorstringdefault: empty

  The name of the author of the comment.

• $comment_author_emailstringdefault: empty

  The email address of the $comment_author.

• $comment_author_IPstringdefault: empty

  The IP address of the $comment_author.

• $comment_author_urlstringdefault: empty

  The URL address of the $comment_author.

• $comment_contentstringdefault: empty

  The content of the comment.

• $comment_datestringdefault: is the current time

  The date the comment was submitted. To set the date manually, $comment_date_gmt must also be specified.

• $comment_date_gmtstringdefault: is $comment_date in the site's GMT timezone

  The date the comment was submitted in the GMT timezone.

• $comment_karmaintdefault: 0

  The karma of the comment.

• $comment_parentintdefault: 0

  ID of this comment's parent, if any.

• $comment_post_IDintdefault: 0

  ID of the post that relates to the comment, if any.

• $comment_typestringdefault: 'comment'

  Comment type.

• $comment_metaarray

  Optional. Array of key/value pairs to be stored in commentmeta for the new comment.

• $user_idintdefault: 0

  ID of the user who submitted the comment.

Return value

int|false

The new comment's ID on success, false on failure.

Performance profile

How much work a call to wp_insert_comment() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->insert().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

88–135

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 175.

Plugin surface

1 hook

Third-party callbacks on 'wp_insert_comment' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• cacheobject cachewp_cache_delete_multiple()called directly
• hookthird-party callbacksdo_action()called directly
• sqldatabase query->insert()called directly
• optionoption read or writeget_option()one call below wp_insert_comment()

Further down the call graph this can also reach serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_insert_comment() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

One hook fires while wp_insert_comment() runs, in this order:

1. 1
   do_action( wp_insert_comment )actionline 2173 (+78 into the body)

   Fires immediately after a comment is inserted into the database.

Uses · 9

• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• current_time()Retrieves the current time based on specified type.
• get_gmt_from_date()Given a date in the timezone of the site, returns that date in UTC.
• wp_update_comment_count()Updates the comment count for post(s).
• wp_cache_delete_multiple()Deletes multiple values from the cache in one call.
• clean_comment_cache()Removes a comment from the object cache.
• get_comment()Retrieves comment data given a comment ID or comment object.
• add_comment_meta()Adds meta data field to a comment.
• do_action()Calls the callback functions that have been added to an action hook.

Used by · 2

• WP_REST_Comments_Controller::create_item()Creates a comment.
• wp_new_comment()Adds a new comment to the database.

Source code

View on Trac ↗View on GitHub ↗

2095function wp_insert_comment( $commentdata ) {2096	global $wpdb;2097 2098	$data = wp_unslash( $commentdata );2099 2100	$comment_author       = ! isset( $data['comment_author'] ) ? '' : $data['comment_author'];2101	$comment_author_email = ! isset( $data['comment_author_email'] ) ? '' : $data['comment_author_email'];2102	$comment_author_url   = ! isset( $data['comment_author_url'] ) ? '' : $data['comment_author_url'];2103	$comment_author_ip    = ! isset( $data['comment_author_IP'] ) ? '' : $data['comment_author_IP'];2104 2105	$comment_date     = ! isset( $data['comment_date'] ) ? current_time( 'mysql' ) : $data['comment_date'];2106	$comment_date_gmt = ! isset( $data['comment_date_gmt'] ) ? get_gmt_from_date( $comment_date ) : $data['comment_date_gmt'];2107 2108	$comment_post_id  = ! isset( $data['comment_post_ID'] ) ? 0 : $data['comment_post_ID'];2109	$comment_content  = ! isset( $data['comment_content'] ) ? '' : $data['comment_content'];2110	$comment_karma    = ! isset( $data['comment_karma'] ) ? 0 : $data['comment_karma'];2111	$comment_approved = ! isset( $data['comment_approved'] ) ? 1 : $data['comment_approved'];2112	$comment_agent    = ! isset( $data['comment_agent'] ) ? '' : $data['comment_agent'];2113	$comment_type     = empty( $data['comment_type'] ) ? 'comment' : $data['comment_type'];2114	$comment_parent   = ! isset( $data['comment_parent'] ) ? 0 : $data['comment_parent'];2115 2116	$user_id = ! isset( $data['user_id'] ) ? 0 : $data['user_id'];2117 2118	$compacted = array(2119		'comment_post_ID'   => $comment_post_id,2120		'comment_author_IP' => $comment_author_ip,2121	);2122 2123	$compacted += compact(2124		'comment_author',2125		'comment_author_email',2126		'comment_author_url',2127		'comment_date',2128		'comment_date_gmt',2129		'comment_content',2130		'comment_karma',2131		'comment_approved',2132		'comment_agent',2133		'comment_type',2134		'comment_parent',2135		'user_id'2136	);2137 2138	if ( ! $wpdb->insert( $wpdb->comments, $compacted ) ) {2139		return false;2140	}2141 2142	$id = (int) $wpdb->insert_id;2143 2144	if ( 1 === (int) $comment_approved ) {2145		wp_update_comment_count( $comment_post_id );2146 2147		$data = array();2148		foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) {2149			$data[] = "lastcommentmodified:$timezone";2150		}2151		wp_cache_delete_multiple( $data, 'timeinfo' );2152	}2153 2154	clean_comment_cache( $id );2155 2156	$comment = get_comment( $id );2157 2158	// If metadata is provided, store it.2159	if ( isset( $commentdata['comment_meta'] ) && is_array( $commentdata['comment_meta'] ) ) {2160		foreach ( $commentdata['comment_meta'] as $meta_key => $meta_value ) {2161			add_comment_meta( $comment->comment_ID, $meta_key, $meta_value, true );2162		}2163	}2164 2165	/**2166	 * Fires immediately after a comment is inserted into the database.2167	 *2168	 * @since 2.8.02169	 *2170	 * @param int        $id      The comment ID.2171	 * @param WP_Comment $comment Comment object.2172	 */2173	do_action( 'wp_insert_comment', $id, $comment );2174

Changelog

Introduced in 4.4.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 6.9.7 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.