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

In this article

Retrieves a page.

Parameters

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

Return

array|IXR_Error

Source

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

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

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

	$page = get_post( $page_id );
	if ( ! $page ) {
		return new IXR_Error( 404, __( 'Invalid post ID.' ) );
	}

	if ( ! current_user_can( 'edit_page', $page_id ) ) {
		return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this page.' ) );
	}

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

	// If we found the page then format the data.
	if ( $page->ID && ( 'page' === $page->post_type ) ) {
		return $this->_prepare_page( $page );
	} else {
		// If the page doesn't exist, indicate that.
		return new IXR_Error( 404, __( 'Sorry, no such page.' ) );
	}
}

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.2.0Introduced.

User Contributed Notes

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