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

• $3int

  Post ID.

• $4array

  Optional. Fields to fetch.

Return value

array|IXR_Error

Array containing a collection of posts.

Performance profile

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

Scaling

Scales with input

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

Instructions

8–58

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

Plugin surface

2 hooks

Third-party callbacks on 'xmlrpc_default_revision_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_post()called directly

Further down the call graph this can also reach cache, option, 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 · 11 distinct outcomes

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

1. 1
   apply_filters( xmlrpc_default_revision_fields )filterline 4710 (+23 into the body)

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

2. 2
   do_action( xmlrpc_call )actionline 4719 (+32 into the body)

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

Uses · 13

• 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()Retrieves post data given a post ID or post object.
• __()Retrieves the translation of $text.
• current_user_can()Returns whether the current user has the specified capability.
• wp_revisions_enabled()Determines whether revisions are enabled for a given post.
• wp_get_post_revisions()Returns all revisions of specified post.
• wp_is_post_autosave()Determines if the specified post is an autosave.
• 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.

Source code

View on Trac ↗View on GitHub ↗

4687	public function wp_getRevisions( $args ) {4688		if ( ! $this->minimum_args( $args, 4 ) ) {4689			return $this->error;4690		}4691 4692		$this->escape( $args );4693 4694		$username = $args[1];4695		$password = $args[2];4696		$post_id  = (int) $args[3];4697 4698		if ( isset( $args[4] ) ) {4699			$fields = $args[4];4700		} else {4701			/**4702			 * Filters the default revision query fields used by the given XML-RPC method.4703			 *4704			 * @since 3.5.04705			 *4706			 * @param array  $field  An array of revision fields to retrieve. By default,4707			 *                       contains 'post_date' and 'post_date_gmt'.4708			 * @param string $method The method name.4709			 */4710			$fields = apply_filters( 'xmlrpc_default_revision_fields', array( 'post_date', 'post_date_gmt' ), 'wp.getRevisions' );4711		}4712 4713		$user = $this->login( $username, $password );4714		if ( ! $user ) {4715			return $this->error;4716		}4717 4718		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */4719		do_action( 'xmlrpc_call', 'wp.getRevisions', $args, $this );4720 4721		$post = get_post( $post_id );4722		if ( ! $post ) {4723			return new IXR_Error( 404, __( 'Invalid post ID.' ) );4724		}4725 4726		if ( ! current_user_can( 'edit_post', $post_id ) ) {4727			return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts.' ) );4728		}4729 4730		// Check if revisions are enabled.4731		if ( ! wp_revisions_enabled( $post ) ) {4732			return new IXR_Error( 401, __( 'Sorry, revisions are disabled.' ) );4733		}4734 4735		$revisions = wp_get_post_revisions( $post_id );4736 4737		if ( ! $revisions ) {4738			return array();4739		}4740 4741		$struct = array();4742 4743		foreach ( $revisions as $revision ) {4744			if ( ! current_user_can( 'read_post', $revision->ID ) ) {4745				continue;4746			}4747 4748			// Skip autosaves.4749			if ( wp_is_post_autosave( $revision ) ) {4750				continue;4751			}4752 4753			$struct[] = $this->_prepare_post( get_object_vars( $revision ), $fields );4754		}4755 4756		return $struct;4757	}

Changelog

Introduced in 3.5.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.