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

In this article

Retrieves a comment.

Parameters

$argsarrayrequired
Method arguments. Note: arguments must be ordered as documented.
  • int
    Blog ID (unused).
  • 1 string
    Username.
  • 2 string
    Password.
  • 3 int
    Comment ID.

Return

array|IXR_Error

Source

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

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

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

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

	$comment = get_comment( $comment_id );
	if ( ! $comment ) {
		return new IXR_Error( 404, __( 'Invalid comment ID.' ) );
	}

	if ( ! current_user_can( 'edit_comment', $comment_id ) ) {
		return new IXR_Error( 403, __( 'Sorry, you are not allowed to moderate or edit this comment.' ) );
	}

	return $this->_prepare_comment( $comment );
}

Hooks

do_action( ‘xmlrpc_call’, string $name, array|string $args, wp_xmlrpc_server $server )

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

Changelog

VersionDescription
2.7.0Introduced.

User Contributed Notes

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