wp.getPost

Retrieve a post of any registered post type.

Added in WordPress 3.4.

Parameters

• string username
• string password
• int post_id
• array fields: Optional. List of field or meta-field names to include in response.

Return Values

• struct: Note that the exact fields returned depends on the fields parameter.
  • string post_id
  • string post_title¹
  • datetime post_date¹
  • datetime post_date_gmt¹
  • datetime post_modified¹
  • datetime post_modified_gmt¹
  • string post_status¹
  • string post_type¹
  • string post_format¹
  • string post_name¹
  • string post_author¹ author id
  • string post_password¹
  • string post_excerpt¹
  • string post_content¹
  • string post_parent¹
  • string post_mime_type¹
  • string link¹
  • string guid¹
  • int menu_order¹
  • string comment_status¹
  • string ping_status¹
  • bool sticky¹
  • struct post_thumbnail¹: See wp.getMediaItem.
  • array terms
    • struct: See wp.getTerm
  • array custom_fields
    • struct
      • string id
      • string key
      • string value
  • struct enclosure
    • string url
    • int length
    • string type

¹ post meta-field

Notes

• In the older metaweblog API, the "Introduction" and the "Read More" content for a post were returned in separate fields "description" and "mt_text_more". In the WordPress API, the two values are combined in the single "post_content" field, separated by the <!--more--> tag.

Errors

• 401
  • If user does not have permission to edit the post.
• 404
  • If no post with that post_id exists.

Filters

xmlrpc_default_post_fields

The default set of fields to be returned can be controlled using the xmlrpc_default_post_fields filter. The default value for this filter is:

array( 'post', 'terms', 'custom_fields' )

xmlrpc_prepare_post

Immediately before returning the prepared post data, the value is passed through the xmlrpc_prepare_post filter. The filter has three parameters:

1. The prepared post data about to be returned
2. The original post data array, see get_post.
3. The fields parameter value.

wp.getPosts

Retrieve list of posts of any registered post type.

Added in WordPress 3.4.

Parameters

• int blog_id
• string username
• string password
• struct filter: Optional.
  • string post_type
  • string post_status
  • int number
  • int offset
  • string orderby
  • string s
  • string order
• array fields: Optional. See #wp.getPost.

Return Values

• array
  • struct: See #wp.getPost.

Notes

• Response will only contain posts that the user has permission to edit. Therefore, there may be fewer than filter['number'] posts in the response.

Filters

Supports same filters as #wp.getPost.

wp.newPost

Create a new post of any registered post type.

Added in WordPress 3.4.

Parameters

• int blog_id
• string username
• string password
• struct content
  • string post_type
  • string post_status
  • string post_title
  • int post_author
  • string post_excerpt
  • string post_content
  • datetime post_date_gmt