WordPress.org

• Home Page
• WordPress Lessons
• Getting Started
• Working with WordPress
• Design and Layout
• Advanced Topics
• Troubleshooting
• Developer Docs
• About WordPress

Codex Resources

• Community portal
• Current events
• Recent changes
• Random page
• Help

XML-RPC wp

Contents 1 wp.getPage 1.1 Parameters 1.2 Return Values 2 wp.getPages 2.1 Parameters 2.2 Return Values 3 wp.getPageList 3.1 Parameters 3.2 Return Values 4 wp.newPage 4.1 Parameters 4.2 Return Values 5 wp.deletePage 5.1 Parameters 5.2 Return Values 6 wp.editPage 6.1 Parameters 6.2 Return Values 7 wp.getAuthors 7.1 Parameters 7.2 Return Values 8 wp.getCategories 8.1 Parameters 8.2 Return Values 9 wp.newCategory 9.1 Parameters 9.2 Return Values 10 wp.suggestCategories 10.1 Parameters 10.2 Return Values 11 wp.uploadFile 11.1 Parameters 11.2 Return Values

wp.getPage

Get the page identified by the page id.

Parameters

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

Return Values

• struct
  • datetime dateCreated (ISO.8601, always GMT)
  • int userid
  • int page_id
  • string page_status
  • string description
  • string title
  • string link
  • string permaLink
  • array categories
    • string Category Name
    • ...
  • string excerpt
  • string text_more
  • int mt_allow_comments
  • int mt_allow_pings
  • string wp_slug
  • string wp_password
  • string wp_author
  • int wp_page_parent_id
  • string wp_page_parent_title
  • int wp_page_order
  • int wp_author_id
  • string wp_author_display_name

---

wp.getPages

Get an array of all the pages on a blog.

Parameters

• int blog_id
• string username
• string password

Return Values

• array
  • struct Same as wp.getPage
  • ...

---

wp.getPageList

Get an array of all the pages on a blog. Just the minimum details, lighter than wp.getPages.

Parameters

• int blog_id
• string username
• string password

Return Values

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

---

wp.newPage

Create a new page. Similar to metaWeblog.newPost.

Parameters

• int blog_id
• string username
• string password
• struct content
  • string wp_slug
  • string wp_password
  • int wp_page_parent_id
  • int wp_page_order
  • int wp_author_id
  • string title
  • string description (content of post)
  • string mt_excerpt
  • string mt_text_more
  • int mt_allow_comments (0 = closed, 1 = open)
  • int mt_allow_pings (0 = closed, 1 = open)
  • datetime dateCreated
• bool publish

Return Values

• int page_id

---

wp.deletePage

Removes a page from the blog.

Parameters

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

Return Values

• bool true

---

wp.editPage

Make changes to a blog page.

Parameters

• int blog_id
• int page_id
• string username
• string password
• struct content
  • Same struct data as newPage
• bool publish

Return Values

• bool true

---

wp.getAuthors

Get an array of users for the blog.

Parameters

• int blog_id
• string username
• string password

Return Values

• array
  • struct
    • int user_id
    • string user_login
    • string display_name
    • string user_email
    • string meta_value (Serialized PHP data)
  • ...

---

wp.getCategories

Get an array of available categories on a blog.

Parameters

• int blog_id
• string username
• string password

Return Values

• array
  • struct
    • int categoryId
    • int parentId
    • string description
    • string categoryName
    • string htmlUrl
    • string rssUrl
  • ...

---

wp.newCategory

Create a new category.

Parameters

• int blog_id
• string username
• string password
• struct
  • string name
  • string slug
  • int parent_id
  • string description

Return Values

• int category_id

---

wp.suggestCategories

Get an array of categories that start with a given string.

Parameters

• int blog_id
• string username
• string password
• string category
• int max_results

Return Values

• array
  • struct
    • int category_id
    • string category_name
  • ...

---

wp.uploadFile

Upload a file.

Parameters

• int blog_id
• string username
• string password
• struct data
  • string name
  • string type
  • base64 bits
  • bool overwrite

Return Values

• struct
  • string file
  • string url
  • string type