wp_xmlrpc_server::wp_suggestCategories()publicWP 2.2.0

Retrieve category list.

Method of the class: wp_xmlrpc_server{}

Hooks from the method

Return

Array|IXR_Error.

Usage

$wp_xmlrpc_server = new wp_xmlrpc_server();
$wp_xmlrpc_server->wp_suggestCategories( $args );
$args(array) (required)

Method arguments. Note: arguments must be ordered as documented.

  • 0(int)
    Blog ID (unused).

  • 1(string)
    Username.

  • 2(string)
    Password.

  • 3(array)
    Category

  • 4(int)
    Max number of results.

Changelog

Since 2.2.0 Introduced.

wp_xmlrpc_server::wp_suggestCategories() code WP 6.1.1

public function wp_suggestCategories( $args ) {
	$this->escape( $args );

	$username    = $args[1];
	$password    = $args[2];
	$category    = $args[3];
	$max_results = (int) $args[4];

	$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', 'wp.suggestCategories', $args, $this );

	$category_suggestions = array();
	$args                 = array(
		'get'        => 'all',
		'number'     => $max_results,
		'name__like' => $category,
	);
	foreach ( (array) get_categories( $args ) as $cat ) {
		$category_suggestions[] = array(
			'category_id'   => $cat->term_id,
			'category_name' => $cat->name,
		);
	}

	return $category_suggestions;
}