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

Retrieve list of all categories on blog.


Parameters

$args array Required
Method arguments. Note: arguments must be ordered as documented.
  • blog_idint
    (unused)
  • usernamestring
  • passwordstring

Top ↑

Return

array|IXR_Error


Top ↑

Source

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

public function mt_getCategoryList( $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', 'mt.getCategoryList', $args, $this );

	$categories_struct = array();

	$cats = get_categories(
		array(
			'hide_empty'   => 0,
			'hierarchical' => 0,
		)
	);
	if ( $cats ) {
		foreach ( $cats as $cat ) {
			$struct                 = array();
			$struct['categoryId']   = $cat->term_id;
			$struct['categoryName'] = $cat->name;

			$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.