wp_xmlrpc_server::wp_getPosts() – Method

Retrieves posts.

Description

Parameters

$argsarrayrequired

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

0 int
Blog ID (unused).
1 string
Username.
2 string
Password.
3 array
Optional. Modifies the query used to retrieve posts. Accepts 'post_type', 'post_status', 'number', 'offset', 'orderby', 's', and 'order'.
Default empty array.
4 array
Optional. The subset of post type fields to return in the response array.

Return

array|IXR_Error Array containing a collection of posts.

Source

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

View all references View on Trac View on GitHub

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.
apply_filters( ‘xmlrpc_default_post_fields’, array $fields, string $method ): Filters the default post query fields used by the given XML-RPC method.

Uses	Description
wp_get_recent_posts()`wp-includes/post.php`	Retrieves a number of recent posts.
wp_xmlrpc_server::minimum_args()`wp-includes/class-wp-xmlrpc-server.php`	Checks if the method received at least the minimum number of arguments.
wp_xmlrpc_server::_prepare_post()`wp-includes/class-wp-xmlrpc-server.php`	Prepares post data for return in an XML-RPC object.
IXR_Error::__construct()`wp-includes/IXR/class-IXR-error.php`	PHP5 constructor.
current_user_can()`wp-includes/capabilities.php`	Returns whether the current user has the specified capability.
absint()`wp-includes/load.php`	Converts a value to non-negative integer.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
do_action()`wp-includes/plugin.php`	Calls the callback functions that have been added to an action hook.
get_post_type_object()`wp-includes/post.php`	Retrieves a post type object by name.
wp_xmlrpc_server::escape()`wp-includes/class-wp-xmlrpc-server.php`	Escapes string or array of strings for database.
wp_xmlrpc_server::login()`wp-includes/class-wp-xmlrpc-server.php`	Logs user in.

Show 8 more Show less

Changelog

Version	Description
3.4.0	Introduced.

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

In this article

Description

See also

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes