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

Compatibility

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

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 value

int|IXR_Error

See wp_new_comment().

Performance profile

How much work a call to wp_xmlrpc_server::wp_newComment() 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 get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

23–152

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

Plugin surface

4 hooks

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()called directly
• querycontent queryget_post()called directly
• cacheobject cachewp_cache_get()one call below wp_xmlrpc_server::wp_newComment()
• serializeserialisationmaybe_unserialize()one call below wp_xmlrpc_server::wp_newComment()

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

What one call costs · 424 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::wp_newComment() 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 · 4

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

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

   Filters whether to allow anonymous comments over XML-RPC.

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

   Filters whether an empty comment should be allowed.

3. 3
   do_action( xmlrpc_call )actionline 4027 (+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 4046 (+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 code

View on Trac ↗View on GitHub ↗

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

Changelog

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