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

Retrieve comment count.


Parameters

$args array Required
Method arguments. Note: arguments must be ordered as documented.
  • blog_idint
    (unused)
  • usernamestring
  • passwordstring
  • post_idint

Top ↑

Return

array|IXR_Error


Top ↑

Source

File: wp-includes/class-wp-xmlrpc-server.php. View all references

public function wp_getCommentCount( $args ) {
	$this->escape( $args );

	$username = $args[1];
	$password = $args[2];
	$post_id  = (int) $args[3];

	$user = $this->login( $username, $password );
	if ( ! $user ) {
		return $this->error;
	}

	$post = get_post( $post_id, ARRAY_A );
	if ( empty( $post['ID'] ) ) {
		return new IXR_Error( 404, __( 'Invalid post ID.' ) );
	}

	if ( ! current_user_can( 'edit_post', $post_id ) ) {
		return new IXR_Error( 403, __( 'Sorry, you are not allowed to access details of this post.' ) );
	}

	/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
	do_action( 'xmlrpc_call', 'wp.getCommentCount', $args, $this );

	$count = wp_count_comments( $post_id );

	return array(
		'approved'            => $count->approved,
		'awaiting_moderation' => $count->moderated,
		'spam'                => $count->spam,
		'total_comments'      => $count->total_comments,
	);
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.