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

Retrieve category list.


Parameters

$args array Required
Method arguments. Note: arguments must be ordered as documented.
  • int
    Blog ID (unused).
  • 1 string
    Username.
  • 2 string
    Password.
  • 3 array
    Category
  • 4 int
    Max number of results.

Top ↑

Return

array|IXR_Error


Top ↑

Source

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

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;
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
2.2.0 Introduced.

Top ↑

User Contributed Notes

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