wp_xmlrpc_server::wp_getTerms() – Method

Retrieves all terms for a taxonomy.

Description

Parameters

$argsarrayrequired

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

int
Blog ID (unused).
1 string
Username.
2 string
Password.
3 string
Taxonomy name.
4 array
Optional. Modifies the query used to retrieve posts. Accepts 'number', 'offset', 'orderby', 'order', 'hide_empty', and 'search'. Default empty array.

Return

array|IXR_Error An associative array of terms data on success, IXR_Error instance otherwise.

Source

public function wp_getTerms( $args ) {
	if ( ! $this->minimum_args( $args, 4 ) ) {
		return $this->error;
	}

	$this->escape( $args );

	$username = $args[1];
	$password = $args[2];
	$taxonomy = $args[3];
	$filter   = isset( $args[4] ) ? $args[4] : array();

	$user = $this->login( $username, $password );
	if ( ! $user ) {
		return $this->error;
	}

	/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
	do_action( 'xmlrpc_call', 'wp.getTerms', $args, $this );

	if ( ! taxonomy_exists( $taxonomy ) ) {
		return new IXR_Error( 403, __( 'Invalid taxonomy.' ) );
	}

	$taxonomy = get_taxonomy( $taxonomy );

	if ( ! current_user_can( $taxonomy->cap->assign_terms ) ) {
		return new IXR_Error( 401, __( 'Sorry, you are not allowed to assign terms in this taxonomy.' ) );
	}

	$query = array( 'taxonomy' => $taxonomy->name );

	if ( isset( $filter['number'] ) ) {
		$query['number'] = absint( $filter['number'] );
	}

	if ( isset( $filter['offset'] ) ) {
		$query['offset'] = absint( $filter['offset'] );
	}

	if ( isset( $filter['orderby'] ) ) {
		$query['orderby'] = $filter['orderby'];

		if ( isset( $filter['order'] ) ) {
			$query['order'] = $filter['order'];
		}
	}

	if ( isset( $filter['hide_empty'] ) ) {
		$query['hide_empty'] = $filter['hide_empty'];
	} else {
		$query['get'] = 'all';
	}

	if ( isset( $filter['search'] ) ) {
		$query['search'] = $filter['search'];
	}

	$terms = get_terms( $query );

	if ( is_wp_error( $terms ) ) {
		return new IXR_Error( 500, $terms->get_error_message() );
	}

	$struct = array();

	foreach ( $terms as $term ) {
		$struct[] = $this->_prepare_term( $term );
	}

	return $struct;
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘xmlrpc_call’, string $name, array|string $args, wp_xmlrpc_server $server ): Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.

Uses	Description
get_terms()`wp-includes/taxonomy.php`	Retrieves the terms in a given taxonomy or list of taxonomies.
taxonomy_exists()`wp-includes/taxonomy.php`	Determines whether the taxonomy name exists.
wp_xmlrpc_server::minimum_args()`wp-includes/class-wp-xmlrpc-server.php`	Checks if the method received at least the minimum number of arguments.
wp_xmlrpc_server::_prepare_term()`wp-includes/class-wp-xmlrpc-server.php`	Prepares term data for return in an XML-RPC object.
IXR_Error::__construct()`wp-includes/IXR/class-IXR-error.php`	PHP5 constructor.
current_user_can()`wp-includes/capabilities.php`	Returns whether the current user has the specified capability.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
absint()`wp-includes/functions.php`	Converts a value to non-negative integer.
get_taxonomy()`wp-includes/taxonomy.php`	Retrieves the taxonomy object of $taxonomy.
do_action()`wp-includes/plugin.php`	Calls the callback functions that have been added to an action hook.
wp_xmlrpc_server::escape()`wp-includes/class-wp-xmlrpc-server.php`	Escapes string or array of strings for database.
wp_xmlrpc_server::login()`wp-includes/class-wp-xmlrpc-server.php`	Logs user in.
is_wp_error()`wp-includes/load.php`	Checks whether the given variable is a WordPress Error.

Show 9 more Show less

Changelog

Version	Description
3.4.0	Introduced.

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

In this article