wp_xmlrpc_server::wp_getPages()publicWP 2.2.0

Retrieves Pages.

Method of the class: wp_xmlrpc_server{}

Hooks from the method

Return

Array|IXR_Error.

Usage

$wp_xmlrpc_server = new wp_xmlrpc_server();
$wp_xmlrpc_server->wp_getPages( $args );
$args(array) (required)

Method arguments. Note: arguments must be ordered as documented.

  • 0(int)
    Blog ID (unused).

  • 1(string)
    Username.

  • 2(string)
    Password.

  • 3(int)
    Optional. Number of pages.
    Default: 10

Changelog

Since 2.2.0 Introduced.

wp_xmlrpc_server::wp_getPages() code WP 6.5.2

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();
}