wp_new_comment( array $commentdata, bool $wp_error = false ): int|false|WP_Error

Description

Parameters

$commentdataarray

Comment data.

• $comment_authorstring

  The name of the comment author.

• $comment_author_emailstring

  The comment author email address.

• $comment_author_urlstring

  The comment author URL.

• $comment_contentstring

  The content of the comment.

• $comment_datestringdefault: is the current time

  The date the comment was submitted.

• $comment_date_gmtstringdefault: is $comment_date in the GMT timezone

  The date the comment was submitted in the GMT timezone.

• $comment_typestringdefault: 'comment'

  Comment type.

• $comment_parentintdefault: 0

  The ID of this comment's parent, if any.

• $comment_post_IDint

  The ID of the post that relates to the comment.

• $user_idintdefault: 0

  The ID of the user who submitted the comment.

• $user_IDint

  Kept for backward-compatibility. Use $user_id instead.

• $comment_agentstring

  Comment author user agent. Default is the value of 'HTTP_USER_AGENT' in the $_SERVER superglobal sent in the original request.

• $comment_author_IPstring

  Comment author IP address in IPv4 format. Default is the value of 'REMOTE_ADDR' in the $_SERVER superglobal sent in the original request.

$wp_errorbooloptional

Should errors be returned as WP_Error objects instead of executing wp_die()? Default false.Default: false

Return

int|false|WP_Error

The ID of the comment on success, false or WP_Error on failure.

Hooks fired · 2

2 hooks fire while wp_new_comment() runs, in this order:

1. 1
   apply_filters( preprocess_comment )filterline 2347 (+33 into the body)

   Filters a comment's data before it is sanitized and inserted into the database.

2. 2
   do_action( comment_post )actionline 2433 (+119 into the body)

   Fires immediately after a comment is inserted into the database.

Uses · 10

• apply_filters()Calls the callback functions that have been added to a filter hook.
• absint()Converts a value to non-negative integer.
• wp_get_comment_status()Retrieves the status of a comment by comment ID.
• current_time()Retrieves the current time based on specified type.
• wp_allow_comment()Validates whether this comment is allowed to be made.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_filter_comment()Filters and sanitizes comment data.
• wp_check_comment_data()Checks whether comment data passes internal checks or has disallowed content.
• wp_insert_comment()Inserts a comment into the database.
• do_action()Calls the callback functions that have been added to an action hook.

Used by · 4

• wp_ajax_replyto_comment()Handles replying to a comment via AJAX.
• wp_handle_comment_submission()Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
• wp_xmlrpc_server::pingback_ping()Retrieves a pingback and registers it.
• wp_xmlrpc_server::wp_newComment()Creates a new comment.

Source

View on Trac ↗View on GitHub ↗

2314function wp_new_comment( $commentdata, $wp_error = false ) {2315	global $wpdb;2316 2317	/*2318	 * Normalize `user_ID` to `user_id`, but pass the old key2319	 * to the `preprocess_comment` filter for backward compatibility.2320	 */2321	if ( isset( $commentdata['user_ID'] ) ) {2322		$commentdata['user_ID'] = (int) $commentdata['user_ID'];2323		$commentdata['user_id'] = $commentdata['user_ID'];2324	} elseif ( isset( $commentdata['user_id'] ) ) {2325		$commentdata['user_id'] = (int) $commentdata['user_id'];2326		$commentdata['user_ID'] = $commentdata['user_id'];2327	}2328 2329	$prefiltered_user_id = ( isset( $commentdata['user_id'] ) ) ? (int) $commentdata['user_id'] : 0;2330 2331	if ( ! isset( $commentdata['comment_author_IP'] ) ) {2332		$commentdata['comment_author_IP'] = $_SERVER['REMOTE_ADDR'];2333	}2334 2335	if ( ! isset( $commentdata['comment_agent'] ) ) {2336		$commentdata['comment_agent'] = $_SERVER['HTTP_USER_AGENT'] ?? '';2337	}2338 2339	/**2340	 * Filters a comment's data before it is sanitized and inserted into the database.2341	 *2342	 * @since 1.5.02343	 * @since 5.6.0 Comment data includes the `comment_agent` and `comment_author_IP` values.2344	 *2345	 * @param array $commentdata Comment data.2346	 */2347	$commentdata = apply_filters( 'preprocess_comment', $commentdata );2348 2349	$commentdata['comment_post_ID'] = (int) $commentdata['comment_post_ID'];2350 2351	// Normalize `user_ID` to `user_id` again, after the filter.2352	if ( isset( $commentdata['user_ID'] ) && $prefiltered_user_id !== (int) $commentdata['user_ID'] ) {2353		$commentdata['user_ID'] = (int) $commentdata['user_ID'];2354		$commentdata['user_id'] = $commentdata['user_ID'];2355	} elseif ( isset( $commentdata['user_id'] ) ) {2356		$commentdata['user_id'] = (int) $commentdata['user_id'];2357		$commentdata['user_ID'] = $commentdata['user_id'];2358	}2359 2360	$commentdata['comment_parent'] = isset( $commentdata['comment_parent'] ) ? absint( $commentdata['comment_parent'] ) : 0;2361 2362	$parent_status = ( $commentdata['comment_parent'] > 0 ) ? wp_get_comment_status( $commentdata['comment_parent'] ) : '';2363 2364	$commentdata['comment_parent'] = ( 'approved' === $parent_status || 'unapproved' === $parent_status ) ? $commentdata['comment_parent'] : 0;2365 2366	$commentdata['comment_author_IP'] = preg_replace( '/[^0-9a-fA-F:., ]/', '', $commentdata['comment_author_IP'] );2367 2368	$commentdata['comment_agent'] = substr( $commentdata['comment_agent'], 0, 254 );2369 2370	if ( empty( $commentdata['comment_date'] ) ) {2371		$commentdata['comment_date'] = current_time( 'mysql' );2372	}2373 2374	if ( empty( $commentdata['comment_date_gmt'] ) ) {2375		$commentdata['comment_date_gmt'] = current_time( 'mysql', true );2376	}2377 2378	if ( empty( $commentdata['comment_type'] ) ) {2379		$commentdata['comment_type'] = 'comment';2380	}2381 2382	$commentdata['comment_approved'] = wp_allow_comment( $commentdata, $wp_error );2383 2384	if ( is_wp_error( $commentdata['comment_approved'] ) ) {2385		return $commentdata['comment_approved'];2386	}2387 2388	$commentdata = wp_filter_comment( $commentdata );2389 2390	if ( ! in_array( $commentdata['comment_approved'], array( 'trash', 'spam' ), true ) ) {2391		// Validate the comment again after filters are applied to comment data.2392		$commentdata['comment_approved'] = wp_check_comment_data( $commentdata );2393	}

History

Introduced in 5.5.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.