wp_xmlrpc_server::mw_getCategories( array $args ): array|IXR_Error

Retrieve the list of categories on a given blog.


Parameters

$args array Required
Method arguments. Note: arguments must be ordered as documented.
  • int
    Blog ID (unused).
  • 1 string
    Username.
  • 2 string
    Password.

Top ↑

Return

array|IXR_Error


Top ↑

Source

File: wp-includes/class-wp-xmlrpc-server.php. View all references

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 ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.