wp_xmlrpc_server::wp_getComments( array $args ): array|IXR_Error

Description

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.

• $3array

  Optional. Query arguments.

Return value

array|IXR_Error

Array containing a collection of comments.
See wp_xmlrpc_server::wp_getComment() for a description of each item contents.

Performance profile

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

Scaling

Scales with input

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

Instructions

18–96

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

Plugin surface

1 hook

Third-party callbacks on '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 callbacksdo_action()called directly
• querycontent queryget_comments()called directly

Further down the call graph this can also reach option, cache, serialize 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 · 16 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   do_action( xmlrpc_call )actionline 3658 (+13 into the body)

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

Uses · 11

• do_action()Calls the callback functions that have been added to an action hook.
• current_user_can()Returns whether the current user has the specified capability.
• __()Retrieves the translation of $text.
• absint()Converts a value to non-negative integer.
• get_post_type_object()Retrieves a post type object by name.
• post_type_supports()Checks a post type's support for a given feature.
• get_comments()Retrieves a list of comments.
• wp_xmlrpc_server::escape()Escapes string or array of strings for database.
• wp_xmlrpc_server::login()Logs user in.
• IXR_Error::__construct()PHP5 constructor.
• wp_xmlrpc_server::_prepare_comment()Prepares comment data for return in an XML-RPC object.

Source code

View on Trac ↗View on GitHub ↗

3645	public function wp_getComments( $args ) {3646		$this->escape( $args );3647 3648		$username = $args[1];3649		$password = $args[2];3650		$struct   = isset( $args[3] ) ? $args[3] : array();3651 3652		$user = $this->login( $username, $password );3653		if ( ! $user ) {3654			return $this->error;3655		}3656 3657		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */3658		do_action( 'xmlrpc_call', 'wp.getComments', $args, $this );3659 3660		if ( isset( $struct['status'] ) ) {3661			$status = $struct['status'];3662		} else {3663			$status = '';3664		}3665 3666		if ( ! current_user_can( 'moderate_comments' ) && 'approve' !== $status ) {3667			return new IXR_Error( 401, __( 'Invalid comment status.' ) );3668		}3669 3670		$post_id = '';3671		if ( isset( $struct['post_id'] ) ) {3672			$post_id = absint( $struct['post_id'] );3673		}3674 3675		$post_type = '';3676		if ( isset( $struct['post_type'] ) ) {3677			$post_type_object = get_post_type_object( $struct['post_type'] );3678			if ( ! $post_type_object || ! post_type_supports( $post_type_object->name, 'comments' ) ) {3679				return new IXR_Error( 404, __( 'Invalid post type.' ) );3680			}3681			$post_type = $struct['post_type'];3682		}3683 3684		$offset = 0;3685		if ( isset( $struct['offset'] ) ) {3686			$offset = absint( $struct['offset'] );3687		}3688 3689		$number = 10;3690		if ( isset( $struct['number'] ) ) {3691			$number = absint( $struct['number'] );3692		}3693 3694		$comments = get_comments(3695			array(3696				'status'    => $status,3697				'post_id'   => $post_id,3698				'offset'    => $offset,3699				'number'    => $number,3700				'post_type' => $post_type,3701			)3702		);3703 3704		$comments_struct = array();3705		if ( is_array( $comments ) ) {3706			foreach ( $comments as $comment ) {3707				$comments_struct[] = $this->_prepare_comment( $comment );3708			}3709		}3710 3711		return $comments_struct;3712	}

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