wp_handle_comment_submission( array $comment_data ): WP_Comment|WP_Error

Description

Parameters

$comment_dataarray

Comment data.

• $comment_post_IDstring|int

  The ID of the post that relates to the comment.

• $authorstring

  The name of the comment author.

• $emailstring

  The comment author email address.

• $urlstring

  The comment author URL.

• $commentstring

  The content of the comment.

• $comment_parentstring|intdefault: 0

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

• $_wp_unfiltered_html_commentstring

  The nonce value for allowing unfiltered HTML.

Return

WP_Comment|WP_Error

A WP_Comment object on success, a WP_Error object on failure.

Hooks fired · 8

8 hooks fire while wp_handle_comment_submission() runs, in this order:

1. 1
   do_action( comment_reply_to_unapproved_comment )actionline 3641 (+43 into the body)

   Fires when a comment reply is attempted to an unapproved comment.

2. 2
   do_action( comment_id_not_found )actionline 3658 (+60 into the body)

   Fires when a comment is attempted on a post that does not exist.

3. 3
   do_action( comment_closed )actionline 3682 (+84 into the body)

   Fires when a comment is attempted on a post that has comments closed.

4. 4
   do_action( comment_on_trash )actionline 3695 (+97 into the body)

   Fires when a comment is attempted on a trashed post.

5. 5
   do_action( comment_on_draft )actionline 3708 (+110 into the body)

   Fires when a comment is attempted on a post in draft mode.

6. 6
   do_action( comment_on_password_protected )actionline 3724 (+126 into the body)

   Fires when a comment is attempted on a password-protected post.

7. 7
   do_action( pre_comment_on_post )actionline 3736 (+138 into the body)

   Fires before a comment is posted.

8. 8
   apply_filters( allow_empty_comment )filterline 3799 (+201 into the body)

   Filters whether an empty comment should be allowed.

Uses · 24

• absint()Converts a value to non-negative integer.
• get_comment()Retrieves comment data given a comment ID or comment object.
• do_action()Calls the callback functions that have been added to an action hook.
• __()Retrieves the translation of $text.
• get_post()Retrieves post data given a post ID or post object.
• get_post_status()Retrieves the post status based on the post ID.
• current_user_can()Returns whether the current user has the specified capability.
• get_post_status_object()Retrieves a post status object by name.
• comments_open()Determines whether the current post is open for comments.
• post_password_required()Determines whether the post requires password and whether a correct password has been provided.
• wp_get_current_user()Retrieves the current user object.
• wp_verify_nonce()Verifies that a correct security nonce was used with time limit.

Source

View on Trac ↗View on GitHub ↗

3598function wp_handle_comment_submission( $comment_data ) {3599	$comment_post_id      = 0;3600	$comment_author       = '';3601	$comment_author_email = '';3602	$comment_author_url   = '';3603	$comment_content      = '';3604	$comment_parent       = 0;3605	$user_id              = 0;3606 3607	if ( isset( $comment_data['comment_post_ID'] ) ) {3608		$comment_post_id = (int) $comment_data['comment_post_ID'];3609	}3610	if ( isset( $comment_data['author'] ) && is_string( $comment_data['author'] ) ) {3611		$comment_author = trim( strip_tags( $comment_data['author'] ) );3612	}3613	if ( isset( $comment_data['email'] ) && is_string( $comment_data['email'] ) ) {3614		$comment_author_email = trim( $comment_data['email'] );3615	}3616	if ( isset( $comment_data['url'] ) && is_string( $comment_data['url'] ) ) {3617		$comment_author_url = trim( $comment_data['url'] );3618	}3619	if ( isset( $comment_data['comment'] ) && is_string( $comment_data['comment'] ) ) {3620		$comment_content = trim( $comment_data['comment'] );3621	}3622	if ( isset( $comment_data['comment_parent'] ) ) {3623		$comment_parent        = absint( $comment_data['comment_parent'] );3624		$comment_parent_object = get_comment( $comment_parent );3625 3626		if (3627			0 !== $comment_parent &&3628			(3629				! $comment_parent_object instanceof WP_Comment ||3630				0 === (int) $comment_parent_object->comment_approved3631			)3632		) {3633			/**3634			 * Fires when a comment reply is attempted to an unapproved comment.3635			 *3636			 * @since 6.2.03637			 *3638			 * @param int $comment_post_id Post ID.3639			 * @param int $comment_parent  Parent comment ID.3640			 */3641			do_action( 'comment_reply_to_unapproved_comment', $comment_post_id, $comment_parent );3642 3643			return new WP_Error( 'comment_reply_to_unapproved_comment', __( 'Sorry, replies to unapproved comments are not allowed.' ), 403 );3644		}3645	}3646 3647	$post = get_post( $comment_post_id );3648 3649	if ( empty( $post->comment_status ) ) {3650 3651		/**3652		 * Fires when a comment is attempted on a post that does not exist.3653		 *3654		 * @since 1.5.03655		 *3656		 * @param int $comment_post_id Post ID.3657		 */3658		do_action( 'comment_id_not_found', $comment_post_id );3659 3660		return new WP_Error( 'comment_id_not_found' );3661 3662	}3663 3664	// get_post_status() will get the parent status for attachments.3665	$status = get_post_status( $post );3666 3667	if ( ( 'private' === $status ) && ! current_user_can( 'read_post', $comment_post_id ) ) {3668		return new WP_Error( 'comment_id_not_found' );3669	}3670 3671	$status_obj = get_post_status_object( $status );3672 3673	if ( ! comments_open( $comment_post_id ) ) {3674 3675		/**3676		 * Fires when a comment is attempted on a post that has comments closed.3677		 *

History

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 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.