wp_xmlrpc_server::wp_getPost( array $args )
Retrieve a post.
Description Description
See also See also
Parameters Parameters
- $args
-
(array) (Required) Method arguments. Note: arguments must be ordered as documented.
- 'blog_id'
(int) Blog ID (unused). - 'username'
(string) Username. - 'password'
(string) Password. - 'post_id'
(int) Post ID. - 'fields'
(array) The subset of post type fields to return.
- 'blog_id'
Return Return
(array|IXR_Error) Array contains (based on $fields parameter): - 'post_id' - 'post_title' - 'post_date' - 'post_date_gmt' - 'post_modified' - 'post_modified_gmt' - 'post_status' - 'post_type' - 'post_name' - 'post_author' - 'post_password' - 'post_excerpt' - 'post_content' - 'link' - 'comment_status' - 'ping_status' - 'sticky' - 'custom_fields' - 'terms' - 'categories' - 'tags' - 'enclosure'
Source Source
File: wp-includes/class-wp-xmlrpc-server.php
public function wp_getPost( $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 list of post query fields used by the given XML-RPC method. * * @since 3.4.0 * * @param array $fields Array of post fields. Default array contains 'post', 'terms', and 'custom_fields'. * @param string $method Method name. */ $fields = apply_filters( 'xmlrpc_default_post_fields', array( 'post', 'terms', 'custom_fields' ), 'wp.getPost' ); } $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.getPost' ); $post = get_post( $post_id, ARRAY_A ); if ( empty( $post['ID'] ) ) { 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 this post.' ) ); } return $this->_prepare_post( $post, $fields ); }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
3.4.0 | Introduced. |