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

Retrieves page list.

Parameters

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

Return

array|IXR_Error

Source

public function wp_getPageList( $args ) {
	global $wpdb;

	$this->escape( $args );

	$username = $args[1];
	$password = $args[2];

	$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.getPageList', $args, $this );

	// Get list of page IDs and titles.
	$page_list = $wpdb->get_results(
		"
		SELECT ID page_id,
			post_title page_title,
			post_parent page_parent_id,
			post_date_gmt,
			post_date,
			post_status
		FROM {$wpdb->posts}
		WHERE post_type = 'page'
		ORDER BY ID
	"
	);

	// The date needs to be formatted properly.
	$num_pages = count( $page_list );
	for ( $i = 0; $i < $num_pages; $i++ ) {
		$page_list[ $i ]->dateCreated      = $this->_convert_date( $page_list[ $i ]->post_date );
		$page_list[ $i ]->date_created_gmt = $this->_convert_date_gmt( $page_list[ $i ]->post_date_gmt, $page_list[ $i ]->post_date );

		unset( $page_list[ $i ]->post_date_gmt );
		unset( $page_list[ $i ]->post_date );
		unset( $page_list[ $i ]->post_status );
	}

	return $page_list;
}

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.