WordPress at a glance
function is not described

wp_xmlrpc_server::wp_getTerms() public WP 3.4.0

Retrieve all terms for a taxonomy.

The optional $filter parameter modifies the query used to retrieve terms. Accepted keys are 'number', 'offset', 'orderby', 'order', 'hide_empty', and 'search'.

{} It's a method of the class: wp_xmlrpc_server{}

Hooks from the method
Return

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

Usage

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

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

  • blog_id(int)
    Blog ID (unused).

  • username(string)
    Username.

  • password(string)
    Password.

  • taxnomy(string)
    Taxonomy name.

  • filter(array)
    Optional. Modifies the query used to retrieve posts. Accepts 'number', 'offset', 'orderby', 'order', 'hide_empty', and 'search'.
    Default: empty array

Notes

  • See: get_terms()

Changelog

Since 3.4.0 Introduced.

Code of wp_xmlrpc_server::wp_getTerms() WP 5.5.3

<?php
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' );

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