wp_xmlrpc_server::wp_getPost() public WP 3.4.0
Retrieve a post.
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.
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'.
{} It's a method of the class: wp_xmlrpc_server{}
Hooks from the method
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'
Usage
$wp_xmlrpc_server = new wp_xmlrpc_server(); $wp_xmlrpc_server->wp_getPost( $args );
- $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.
-
Notes
- See: get_post()
Changelog
Since 3.4.0 | Introduced. |
Code of wp_xmlrpc_server::wp_getPost() wp xmlrpc server::wp getPost WP 5.7.1
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', $args, $this );
$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 );
}