wp_xmlrpc_server::wp_getRevisions() WordPress Method
This method retrieves a list of all the revisions for a given post. The method takes two parameters: the post ID and an array of options. The available options are: - max: The maximum number of revisions to retrieve. - offset: The number of revisions to offset the query. - orderby: The order in which to retrieve the revisions. Valid values are 'date', 'ID', or 'author'. - order: The direction in which to order the revisions. Valid values are 'ASC' or 'DESC'. The method returns an array of revision objects. Each revision object has the following properties: - ID: The revision ID. - post_ID: The post ID. - author: The revision author. - date: The revision date. - content: The revision content.
wp_xmlrpc_server::wp_getRevisions( array $args ) #
Retrieve revisions for a specific post.
Description
See also
- wp_getPost(): for more on $fields
Parameters
- $args
(array)(Required)Method arguments. Note: arguments must be ordered as documented.
- 'blog_id'
(int) (unused) - 'username'
(string) - 'password'
(string) - 'post_id'
(int) - 'fields'
(array) (optional)
- 'blog_id'
Return
(array|IXR_Error) contains a collection of posts.
Source
File: wp-includes/class-wp-xmlrpc-server.php
public function wp_getRevisions( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) { return $this->error; } $this->escape( $args ); $username = $args[1]; $password = $args[2]; $post_id = (int) $args[3]; if ( isset( $args[4] ) ) { $fields = $args[4]; } else { /** * Filters the default revision query fields used by the given XML-RPC method. * * @since 3.5.0 * * @param array $field An array of revision query fields. * @param string $method The method name. */ $fields = apply_filters( 'xmlrpc_default_revision_fields', array( 'post_date', 'post_date_gmt' ), 'wp.getRevisions' ); } $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.getRevisions', $args, $this ); $post = get_post( $post_id ); if ( ! $post ) { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); } if ( ! current_user_can( 'edit_post', $post_id ) ) { return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts.' ) ); } // Check if revisions are enabled. if ( ! wp_revisions_enabled( $post ) ) { return new IXR_Error( 401, __( 'Sorry, revisions are disabled.' ) ); } $revisions = wp_get_post_revisions( $post_id ); if ( ! $revisions ) { return array(); } $struct = array(); foreach ( $revisions as $revision ) { if ( ! current_user_can( 'read_post', $revision->ID ) ) { continue; } // Skip autosaves. if ( wp_is_post_autosave( $revision ) ) { continue; } $struct[] = $this->_prepare_post( get_object_vars( $revision ), $fields ); } return $struct; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.5.0 | Introduced. |