wp_xmlrpc_server::wp_getPostTypes( 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.

• $3array

  Optional. Query arguments.

• $4array

  Optional. Fields to fetch.

Return value

array|IXR_Error

Performance profile

How much work a call to wp_xmlrpc_server::wp_getPostTypes() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

8–46

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

Plugin surface

2 hooks

Third-party callbacks on 'xmlrpc_default_posttype_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

Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 5 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::wp_getPostTypes() 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_getPostTypes() runs, in this order:

1. 1
   apply_filters( xmlrpc_default_posttype_fields )filterline 4639 (+15 into the body)

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

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

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

Uses · 8

• 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_types()Gets a list of all registered post type objects.
• current_user_can()Returns whether the current user has the specified capability.
• 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.
• wp_xmlrpc_server::_prepare_post_type()Prepares post data for return in an XML-RPC object.

Source code

View on Trac ↗View on GitHub ↗

4624	public function wp_getPostTypes( $args ) {4625		if ( ! $this->minimum_args( $args, 3 ) ) {4626			return $this->error;4627		}4628 4629		$this->escape( $args );4630 4631		$username = $args[1];4632		$password = $args[2];4633		$filter   = $args[3] ?? array( 'public' => true );4634 4635		if ( isset( $args[4] ) ) {4636			$fields = $args[4];4637		} else {4638			/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */4639			$fields = apply_filters( 'xmlrpc_default_posttype_fields', array( 'labels', 'cap', 'taxonomies' ), 'wp.getPostTypes' );4640		}4641 4642		$user = $this->login( $username, $password );4643		if ( ! $user ) {4644			return $this->error;4645		}4646 4647		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */4648		do_action( 'xmlrpc_call', 'wp.getPostTypes', $args, $this );4649 4650		$post_types = get_post_types( $filter, 'objects' );4651 4652		$struct = array();4653 4654		foreach ( $post_types as $post_type ) {4655			if ( ! current_user_can( $post_type->cap->edit_posts ) ) {4656				continue;4657			}4658 4659			$struct[ $post_type->name ] = $this->_prepare_post_type( $post_type, $fields );4660		}4661 4662		return $struct;4663	}

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 7.1.0 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.