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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarray

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

• $0int

  Blog ID (unused).

• $1string

  Username.

• $2string

  Password.

• $3arraydefault: empty array

  Optional. Modifies the query used to retrieve posts. Accepts 'post_type', 'post_status', 'number', 'offset', 'orderby', 's', and 'order'.

• $4array

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

Return value

array|IXR_Error

Array containing a collection of posts.

Performance profile

How much work a call to wp_xmlrpc_server::wp_getPosts() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_posts().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

8–105

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 147.

Plugin surface

2 hooks

Third-party callbacks on 'xmlrpc_default_post_fields', 'xmlrpc_call' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_posts()one call below wp_xmlrpc_server::wp_getPosts()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 13 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::wp_getPosts() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_xmlrpc_server::wp_getPosts() runs, in this order:

1. 1
   apply_filters( xmlrpc_default_post_fields )filterline 1995 (+15 into the body)

   Filters the default post query fields used by the given XML-RPC method.

2. 2
   do_action( xmlrpc_call )actionline 2004 (+24 into the body)

   Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.

Uses · 12

• apply_filters()Calls the callback functions that have been added to a filter hook.
• do_action()Calls the callback functions that have been added to an action hook.
• get_post_type_object()Retrieves a post type object by name.
• __()Retrieves the translation of $text.
• current_user_can()Returns whether the current user has the specified capability.
• absint()Converts a value to non-negative integer.
• wp_get_recent_posts()Retrieves a number of recent posts.
• wp_xmlrpc_server::minimum_args()Checks if the method received at least the minimum number of arguments.
• wp_xmlrpc_server::escape()Escapes string or array of strings for database.
• wp_xmlrpc_server::login()Logs user in.
• IXR_Error::__construct()PHP5 constructor.
• wp_xmlrpc_server::_prepare_post()Prepares post data for return in an XML-RPC object.

Source code

View on Trac ↗View on GitHub ↗

1980	public function wp_getPosts( $args ) {1981		if ( ! $this->minimum_args( $args, 3 ) ) {1982			return $this->error;1983		}1984 1985		$this->escape( $args );1986 1987		$username = $args[1];1988		$password = $args[2];1989		$filter   = isset( $args[3] ) ? $args[3] : array();1990 1991		if ( isset( $args[4] ) ) {1992			$fields = $args[4];1993		} else {1994			/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */1995			$fields = apply_filters( 'xmlrpc_default_post_fields', array( 'post', 'terms', 'custom_fields' ), 'wp.getPosts' );1996		}1997 1998		$user = $this->login( $username, $password );1999		if ( ! $user ) {2000			return $this->error;2001		}2002 2003		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */2004		do_action( 'xmlrpc_call', 'wp.getPosts', $args, $this );2005 2006		$query = array();2007 2008		if ( isset( $filter['post_type'] ) ) {2009			$post_type = get_post_type_object( $filter['post_type'] );2010			if ( ! ( (bool) $post_type ) ) {2011				return new IXR_Error( 403, __( 'Invalid post type.' ) );2012			}2013		} else {2014			$post_type = get_post_type_object( 'post' );2015		}2016 2017		if ( ! current_user_can( $post_type->cap->edit_posts ) ) {2018			return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts in this post type.' ) );2019		}2020 2021		$query['post_type'] = $post_type->name;2022 2023		if ( isset( $filter['post_status'] ) ) {2024			$query['post_status'] = $filter['post_status'];2025		}2026 2027		if ( isset( $filter['number'] ) ) {2028			$query['numberposts'] = absint( $filter['number'] );2029		}2030 2031		if ( isset( $filter['offset'] ) ) {2032			$query['offset'] = absint( $filter['offset'] );2033		}2034 2035		if ( isset( $filter['orderby'] ) ) {2036			$query['orderby'] = $filter['orderby'];2037 2038			if ( isset( $filter['order'] ) ) {2039				$query['order'] = $filter['order'];2040			}2041		}2042 2043		if ( isset( $filter['s'] ) ) {2044			$query['s'] = $filter['s'];2045		}2046 2047		$posts_list = wp_get_recent_posts( $query );2048 2049		if ( ! $posts_list ) {2050			return array();2051		}2052 2053		// Holds all the posts data.2054		$struct = array();2055 2056		foreach ( $posts_list as $post ) {2057			if ( ! current_user_can( 'edit_post', $post['ID'] ) ) {2058				continue;2059			}

Changelog

Introduced in 3.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/class-wp-xmlrpc-server.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.