wp_xmlrpc_server::wp_getPost( array $args )
Retrieves a post.
Description
See also
Parameters
- $args
-
(Required) Method arguments. Note: arguments must be ordered as documented.<br>
- (int) Blog ID (unused).<br>
- '1'
(string) Username.<br> - '2'
(string) Password.<br> - '3'
(int) Post ID.<br> - '4'
(array) Optional. The subset of post type fields to return.<br>
Return
(array|IXR_Error) Array contains (based on $fields parameter):<br>
- 'post_id'<br>
- 'post_title'<br>
- 'post_date'<br>
- 'post_date_gmt'<br>
- 'post_modified'<br>
- 'post_modified_gmt'<br>
- 'post_status'<br>
- 'post_type'<br>
- 'post_name'<br>
- 'post_author'<br>
- 'post_password'<br>
- 'post_excerpt'<br>
- 'post_content'<br>
- 'link'<br>
- 'comment_status'<br>
- 'ping_status'<br>
- 'sticky'<br>
- 'custom_fields'<br>
- 'terms'<br>
- 'categories'<br>
- 'tags'<br>
- 'enclosure'
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 WP-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' );
}
if ( ! $user = $this->login( $username, $password ) )
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 );
}
Changelog
Version | Description |
---|---|
3.4.0 | Introduced. The optional $fields parameter specifies what fields will be included in the response array. This should be a list of field names. 'post_id' will always be included in the response regardless of the value of $fields.<br>Instead of, or in addition to, individual field names, conceptual group names can be used to specify multiple fields. The available conceptual groups are 'post' (all basic fields), 'taxonomies', 'custom_fields', and 'enclosure'. |