wp_xmlrpc_server::wp_getPosts() public WP 3.4.0

Retrieve posts.

{} It's a method of the class: wp_xmlrpc_server{}

Return

Array|IXR_Error. Array contains a collection of posts.

Usage

$wp_xmlrpc_server = new wp_xmlrpc_server();
$wp_xmlrpc_server->wp_getPosts( $args );

$args(array) (required)

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

• blog_id(int)
  Blog ID (unused).

• username(string)
  Username.

• password(string)
  Password.

• filter(array)
  Optional. Modifies the query used to retrieve posts. Accepts 'post_type', 'post_status', 'number', 'offset', 'orderby', 's', and 'order'.
  Default: empty array

• fields(array)
  Optional. The subset of post type fields to return in the response array.

Notes

• See: wp_get_recent_posts()
• See: wp_getPost() for more on $fields
• See: get_posts() for more on $filter values

Changelog

Code of wp_xmlrpc_server::wp_getPosts() wp xmlrpc server::wp getPosts ^{WP 5.7.1}

<?php
public function wp_getPosts( $args ) {
	if ( ! $this->minimum_args( $args, 3 ) ) {
		return $this->error;
	}

	$this->escape( $args );

	$username = $args[1];
	$password = $args[2];
	$filter   = isset( $args[3] ) ? $args[3] : array();

	if ( isset( $args[4] ) ) {
		$fields = $args[4];
	} else {
		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
		$fields = apply_filters( 'xmlrpc_default_post_fields', array( 'post', 'terms', 'custom_fields' ), 'wp.getPosts' );
	}

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

	$query = array();

	if ( isset( $filter['post_type'] ) ) {
		$post_type = get_post_type_object( $filter['post_type'] );
		if ( ! ( (bool) $post_type ) ) {
			return new IXR_Error( 403, __( 'Invalid post type.' ) );
		}
	} else {
		$post_type = get_post_type_object( 'post' );
	}

	if ( ! current_user_can( $post_type->cap->edit_posts ) ) {
		return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts in this post type.' ) );
	}

	$query['post_type'] = $post_type->name;

	if ( isset( $filter['post_status'] ) ) {
		$query['post_status'] = $filter['post_status'];
	}

	if ( isset( $filter['number'] ) ) {
		$query['numberposts'] = absint( $filter['number'] );
	}

	if ( isset( $filter['offset'] ) ) {
		$query['offset'] = absint( $filter['offset'] );
	}

	if ( isset( $filter['orderby'] ) ) {
		$query['orderby'] = $filter['orderby'];

		if ( isset( $filter['order'] ) ) {
			$query['order'] = $filter['order'];
		}
	}

	if ( isset( $filter['s'] ) ) {
		$query['s'] = $filter['s'];
	}

	$posts_list = wp_get_recent_posts( $query );

	if ( ! $posts_list ) {
		return array();
	}

	// Holds all the posts data.
	$struct = array();

	foreach ( $posts_list as $post ) {
		if ( ! current_user_can( 'edit_post', $post['ID'] ) ) {
			continue;
		}

		$struct[] = $this->_prepare_post( $post, $fields );
	}

	return $struct;
}