WordPress.org

XML-RPC WordPress API/Categories & Tags

Methods related to categories and tags. As of WordPress 3.4, clients should prefer methods from the Taxonomies component.

Contents 1 wp.getCategories 1.1 Parameters 1.2 Return Values 1.3 Errors 1.4 Replacement 2 wp.suggestCategories 2.1 Parameters 2.2 Return Values 2.3 Errors 2.4 Replacement 3 wp.newCategory 3.1 Parameters 3.2 Return Values 3.3 Errors 3.4 Replacement 4 wp.deleteCategory 4.1 Parameters 4.2 Return Values 4.3 Errors 4.4 Replacement 5 wp.getTags 5.1 Parameters 5.2 Return Values 5.3 Errors 5.4 Replacement

wp.getCategories

Retrieve list of categories.

Parameters

• int blogid
• string username
• string password

Return Values

• array
  • struct
    • string categoryId
    • string parentId
    • string categoryName
    • string categoryDescription
    • string description: Name of the category, equivalent to categoryName.
    • string htmlUrl
    • string rssUrl

Errors

• 401
  • If the user does not have the edit_posts cap.

Replacement

As of WordPress 3.4, it is preferable to use the wp.getTerms method, with category as the taxonomy_name parameter.

wp.suggestCategories

Retrieve list of categories that start with a given string.

Added in WordPress 2.2.

Parameters

• int blogid
• string username
• string password
• string category: Beginning of category name.
• int max_results

Return Values

• array
  • struct
    • string category_id
    • string category_name

Errors

• 401
  • If the user does not have the edit_posts cap.

Replacement

As of WordPress 3.4, it is preferable to use the wp.getTerms method, with category as the taxonomy_name parameter and the category prefix as the search parameter.

wp.newCategory

Create a category.

Added in WordPress 2.2.

Parameters

• int blogid
• string username
• string password
• struct category
  • string name
  • string description
  • int parent_id
  • string slug

Return Values

• int category_id

Errors

• 403
  • If the user does not have the manage_categories cap.

Replacement

As of WordPress 3.4, it is preferable to use the wp.newTerm method, with category as the taxonomy_name parameter.

wp.deleteCategory

Delete an existing category.

Added in WordPress 2.5.

Parameters

• int blogid
• string username
• string password
• int category_id

Return Values

• bool true

Errors

• 401
  • If the user does not have the manage_categories cap.

Replacement

As of WordPress 3.4, it is preferable to use the wp.deleteTerm method, with category as the taxonomy_name parameter.

wp.getTags

Retrieve list of all tags.

Added in WordPress 2.7.

Parameters

• int blogid
• string username
• string password

Return Values

• array
  • struct
    • int tag_id
    • string name
    • string slug
    • int count
    • string html_url
    • string rss_url

Errors

• 401
  • If the user does not have the edit_posts cap.

Replacement

As of WordPress 3.4, it is preferable to use the wp.getTerms method, with post_tag as the taxonomy_name parameter.

• 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