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

In this article

Retrieves Pages.

Parameters

$argsarrayrequired
Method arguments. Note: arguments must be ordered as documented.
  • int
    Blog ID (unused).
  • 1 string
    Username.
  • 2 string
    Password.
  • 3 int
    Optional. Number of pages. Default 10.

Return

array|IXR_Error

Source

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

	$username  = $args[1];
	$password  = $args[2];
	$num_pages = isset( $args[3] ) ? (int) $args[3] : 10;

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

	if ( ! current_user_can( 'edit_pages' ) ) {
		return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit pages.' ) );
	}

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

	$pages     = get_posts(
		array(
			'post_type'   => 'page',
			'post_status' => 'any',
			'numberposts' => $num_pages,
		)
	);
	$num_pages = count( $pages );

	// If we have pages, put together their info.
	if ( $num_pages >= 1 ) {
		$pages_struct = array();

		foreach ( $pages as $page ) {
			if ( current_user_can( 'edit_page', $page->ID ) ) {
				$pages_struct[] = $this->_prepare_page( $page );
			}
		}

		return $pages_struct;
	}

	return array();
}

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.