WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

XML-RPC WordPress API/Pages

wp.getPage

Retrieve a page.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • int page_id
  • string username
  • string password

Return Values

  • struct
    • int page_id
    • string title
    • datetime dateCreated
    • datetime date_created_gmt
    • string page_status
    • string wp_slug
    • int userid
    • string wp_author_id
    • string wp_author
    • string wp_author_display_name
    • string wp_password
    • string excerpt
    • string description
    • string text_more
    • string permaLink
    • int mt_allow_comments
    • int mt_allow_pings
    • int wp_page_parent_id
    • string wp_page_parent
    • int wp_page_order
    • string wp_page_template
    • array categories: Names of categories assigned to the page.
    • array custom_fields
      • struct
        • string id
        • string key
        • string value

Errors

  • 401
  • 404
    • If no page with that page_id exists.

wp.getPages

Retrieve list of pages with full details.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • string username
  • string password
  • int max_pages: Optional, default=10.

Return Values

Errors

  • 401

wp.getPageList

Retrieve full list of pages with minimum details.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • string username
  • string password

Return Values

  • array
    • struct
      • int page_id
      • string page_title
      • int page_parent_id
      • datetime dateCreated
      • datetime date_created_gmt

Errors

  • 401

wp.newPage

Create a new page.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • string username
  • string password
    • string title
    • string description: Page content.
    • datetime dateCreated
    • datetime date_created_gmt: If specified, takes precedence over dateCreated.
    • array categories: Names of categories assigned to the page.
    • array mt_keywords: Names of tags assigned to the page.
    • string mt_excerpt
    • string mt_text_more: Post "Read more" text.
    • string mt_allow_comments: "open" or "closed"
    • string mt_allow_pings: "open" or "closed"
    • string wp_slug
    • string wp_password
    • string wp_author_id
    • string wp_author_display_name
    • string page_status
    • int wp_page_parent_id
    • string wp_page_parent
    • int wp_page_order
    • string wp_page_template
    • array custom_fields (Added in WordPress 2.3.2)
      • struct
        • string id: Optional.
        • string key
        • string value
    • struct enclosure: Only set if page has an enclosure. (Added in WordPress 2.6.3)
      • string url
      • int length
      • string type
  • bool publish: Whether to publish the page upon creation or leave it as a draft.

Return Values

  • int page_id

Errors

  • 401

wp.editPage

Edit an existing page.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • int page_id
  • string username
  • string password
  • struct content: See #wp.newPage.
  • bool publish

Return Values

  • bool true

Errors

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

wp.deletePage

Delete an existing page.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • string username
  • string password
  • int page_id

Return Values

  • bool true

Errors

  • 401
    • If the user does not have permission to delete the page.
  • 404
    • If no page with that page_id exists.

wp.getPageStatusList

Retrieve list of supported values for post_status field on posts.

Added in WordPress 2.5.

Parameters

  • int blog_id
  • string username
  • string password

Return Values

  • struct: keys are the statuses, values are the display name for the status.

Example response data:

array(
  'draft'   => 'Draft',
  'private' => 'Private',
  'publish' => 'Published'
);

Errors

  • 403

wp.getPageTemplates

Retrieve page templates for the active theme.

Added in WordPress 2.6.

Parameters

  • int blog_id
  • string username
  • string password

Return Values

  • struct: keys are the display name, values are the template filename. See get_page_templates.

Errors

  • 403