wp_xmlrpc_server::mw_getCategories() WordPress Method

The wp_xmlrpc_server::mw_getCategories() method is used to get a list of all the categories on a WordPress site. This is useful for managing a large number of categories, or for creating a custom interface for managing categories.

wp_xmlrpc_server::mw_getCategories( array $args ) #

Retrieve the list of categories on a given blog.


Parameters

$args

(array)(Required)Method arguments. Note: arguments must be ordered as documented.

  • 'blog_id'
    (int) (unused)
  • 'username'
    (string)
  • 'password'
    (string)


Top ↑

Return

(array|IXR_Error)


Top ↑

Source

File: wp-includes/class-wp-xmlrpc-server.php

6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
public function mw_getCategories( $args ) {
    $this->escape( $args );
 
    $username = $args[1];
    $password = $args[2];
 
    $user = $this->login( $username, $password );
    if ( ! $user ) {
        return $this->error;
    }
 
    if ( ! current_user_can( 'edit_posts' ) ) {
        return new IXR_Error( 401, __( 'Sorry, you must be able to edit posts on this site in order to view categories.' ) );
    }
 
    /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
    do_action( 'xmlrpc_call', 'metaWeblog.getCategories', $args, $this );
 
    $categories_struct = array();
 
    $cats = get_categories( array( 'get' => 'all' ) );
    if ( $cats ) {
        foreach ( $cats as $cat ) {
            $struct                        = array();
            $struct['categoryId']          = $cat->term_id;
            $struct['parentId']            = $cat->parent;
            $struct['description']         = $cat->name;
            $struct['categoryDescription'] = $cat->description;
            $struct['categoryName']        = $cat->name;
            $struct['htmlUrl']             = esc_html( get_category_link( $cat->term_id ) );
            $struct['rssUrl']              = esc_html( get_category_feed_link( $cat->term_id, 'rss2' ) );
 
            $categories_struct[] = $struct;
        }
    }
 
    return $categories_struct;
}


Top ↑

Changelog

Changelog
VersionDescription
1.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More