wp_xmlrpc_server::wp_newComment( array $args ): int|IXR_Error

Parameters

$argsarray

Method arguments. Note: arguments must be ordered as documented.

• $0int

  Blog ID (unused).

• $1string

  Username.

• $2string

  Password.

• $3string|int

  Post ID or URL.

• $4array

  Content structure.

Return

int|IXR_Error

See wp_new_comment().

Hooks fired · 4

4 hooks fire while wp_xmlrpc_server::wp_newComment() runs, in this order:

1. 1
   apply_filters( xmlrpc_allow_anonymous_comments )filterline 3933 (+16 into the body)

   Filters whether to allow anonymous comments over XML-RPC.

2. 2
   apply_filters( allow_empty_comment )filterline 4025 (+108 into the body)

   Filters whether an empty comment should be allowed.

3. 3
   do_action( xmlrpc_call )actionline 4032 (+115 into the body)

   Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.

4. 4
   do_action( xmlrpc_call_success_wp_newComment )actionline 4051 (+134 into the body)

   Fires after a new comment has been successfully created via XML-RPC.

Uses · 17

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_option()Retrieves an option value based on an option name.
• __()Retrieves the translation of $text.
• absint()Converts a value to non-negative integer.
• url_to_postid()Examines a URL and try to determine the post ID it represents.
• get_post()Retrieves post data given a post ID or post object.
• comments_open()Determines whether the current post is open for comments.
• get_post_status()Retrieves the post status based on the post ID.
• current_user_can()Returns whether the current user has the specified capability.
• post_password_required()Determines whether the post requires password and whether a correct password has been provided.
• is_email()Verifies that an email is valid.
• do_action()Calls the callback functions that have been added to an action hook.

Source

View on Trac ↗View on GitHub ↗

3917	public function wp_newComment( $args ) {3918		$this->escape( $args );3919 3920		$username       = $args[1];3921		$password       = $args[2];3922		$post           = $args[3];3923		$content_struct = $args[4];3924 3925		/**3926		 * Filters whether to allow anonymous comments over XML-RPC.3927		 *3928		 * @since 2.7.03929		 *3930		 * @param bool $allow Whether to allow anonymous commenting via XML-RPC.3931		 *                    Default false.3932		 */3933		$allow_anon = apply_filters( 'xmlrpc_allow_anonymous_comments', false );3934 3935		$user = $this->login( $username, $password );3936 3937		if ( ! $user ) {3938			$logged_in = false;3939			if ( $allow_anon && get_option( 'comment_registration' ) ) {3940				return new IXR_Error( 403, __( 'Sorry, you must be logged in to comment.' ) );3941			} elseif ( ! $allow_anon ) {3942				return $this->error;3943			}3944		} else {3945			$logged_in = true;3946		}3947 3948		if ( is_numeric( $post ) ) {3949			$post_id = absint( $post );3950		} else {3951			$post_id = url_to_postid( $post );3952		}3953 3954		if ( ! $post_id ) {3955			return new IXR_Error( 404, __( 'Invalid post ID.' ) );3956		}3957 3958		if ( ! get_post( $post_id ) ) {3959			return new IXR_Error( 404, __( 'Invalid post ID.' ) );3960		}3961 3962		if ( ! comments_open( $post_id ) ) {3963			return new IXR_Error( 403, __( 'Sorry, comments are closed for this item.' ) );3964		}3965 3966		if (3967			'publish' === get_post_status( $post_id ) &&3968			! current_user_can( 'edit_post', $post_id ) &&3969			post_password_required( $post_id )3970		) {3971			return new IXR_Error( 403, __( 'Sorry, you are not allowed to comment on this post.' ) );3972		}3973 3974		if (3975			'private' === get_post_status( $post_id ) &&3976			! current_user_can( 'read_post', $post_id )3977		) {3978			return new IXR_Error( 403, __( 'Sorry, you are not allowed to comment on this post.' ) );3979		}3980 3981		$comment = array(3982			'comment_post_ID' => $post_id,3983			'comment_content' => trim( $content_struct['content'] ),3984		);3985 3986		if ( $logged_in ) {3987			$display_name = $user->display_name;3988			$user_email   = $user->user_email;3989			$user_url     = $user->user_url;3990 3991			$comment['comment_author']       = $this->escape( $display_name );3992			$comment['comment_author_email'] = $this->escape( $user_email );3993			$comment['comment_author_url']   = $this->escape( $user_url );3994			$comment['user_id']              = $user->ID;3995		} else {3996			$comment['comment_author'] = '';

History

Introduced in 2.7.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.1.0 tag, from src/wp-includes/class-wp-xmlrpc-server.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.