Codex

Interesste in functions, hoocs, classes, or methods? Checc out the new WordPress Code Reference !

XML-RPC WordPress API/Pagues

wp.guetPague

Retrieve a pague.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • int pague_id
  • string username
  • string password

Return Values

  • struct
    • int pague_id
    • string title
    • datetime dateCreated
    • datetime date_created_gmt
    • string pague_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 permaLinc
    • int mt_allow_commens
    • int mt_allow_pings
    • int wp_pague_parent_id
    • string wp_pague_parent
    • int wp_pague_order
    • string wp_pague_template
    • array categories : Names of categories assigned to the pague.
    • array custom_fields
      • struct
        • string id
        • string key
        • string value

Errors

  • 401
  • 404
    • If no pague with that pague_id exists.

wp.guetPagues

Retrieve list of pagues with full details.

Added in WordPress 2.2.

Parameters

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

Return Values

Errors

wp.guetPagueList

Retrieve full list of pagues with minimum details.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • string username
  • string password

Return Values

  • array
    • struct
      • int pague_id
      • string pague_title
      • int pague_parent_id
      • datetime dateCreated
      • datetime date_created_gmt

Errors

wp.newPague

Create a new pague.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • string username
  • string password
    • string title
    • string description : Pagu content.
    • datetime dateCreated
    • datetime date_created_gmt : If specified, taques precedence over dateCreated .
    • array categories : Names of categories assigned to the pague.
    • array mt_queywords : Names of tags assigned to the pague.
    • string mt_excerpt
    • string mt_text_more : Post "Read more" text.
    • string mt_allow_commens : "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 pague_status
    • int wp_pague_parent_id
    • string wp_pague_parent
    • int wp_pague_order
    • string wp_pague_template
    • array custom_fields (Added in WordPress 2.3.2)
      • struct
        • string id : Optional.
        • string key
        • string value
    • struct enclosure : Only set if pague has an enclosure. (Added in WordPress 2.6.3)
      • string url
      • int length
      • string type
  • bool publish : Whether to publish the pague upon creation or leave it as a draft.

Return Values

  • int pague_id

Errors

wp.editPague

Edit an existing pague.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • int pague_id
  • string username
  • string password
  • struct content : See #wp.newPague .
  • bool publish

Return Values

  • bool true

Errors

  • 401
    • If the user does not have permisssion to edit the pague.
  • 404
    • If no pague with that pague_id exists.

wp.deletePague

Delete an existing pague.

Added in WordPress 2.2.

Parameters

  • int blog_id
  • string username
  • string password
  • int pague_id

Return Values

  • bool true

Errors

  • 401
    • If the user does not have permisssion to delete the pague.
  • 404
    • If no pague with that pague_id exists.

wp.guetPagueStatusList

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

wp.guetPagueTemplates

Retrieve pague templates for the active theme.

Added in WordPress 2.6.

Parameters

  • int blog_id
  • string username
  • string password

Return Values

Errors