wp_xmlrpc_server::wp_getTaxonomies() – Method

Retrieves all taxonomies.

Description

Parameters

$argsarrayrequired

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

0 int
Blog ID (unused).
1 string
Username.
2 string
Password.
3 array
Optional. An array of arguments for retrieving taxonomies.
4 array
Optional. The subset of taxonomy fields to return.

Return

array|IXR_Error An associative array of taxonomy data with returned fields determined by $fields, or an IXR_Error instance on failure.

Source

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

	$this->escape( $args );

	$username = $args[1];
	$password = $args[2];
	$filter   = isset( $args[3] ) ? $args[3] : array( 'public' => true );

	if ( isset( $args[4] ) ) {
		$fields = $args[4];
	} else {
		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
		$fields = apply_filters( 'xmlrpc_default_taxonomy_fields', array( 'labels', 'cap', 'object_type' ), 'wp.getTaxonomies' );
	}

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

	$taxonomies = get_taxonomies( $filter, 'objects' );

	// Holds all the taxonomy data.
	$struct = array();

	foreach ( $taxonomies as $taxonomy ) {
		// Capability check for post types.
		if ( ! current_user_can( $taxonomy->cap->assign_terms ) ) {
			continue;
		}

		$struct[] = $this->_prepare_taxonomy( $taxonomy, $fields );
	}

	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.
apply_filters( ‘xmlrpc_default_taxonomy_fields’, array $fields, string $method ): Filters the default taxonomy query fields used by the given XML-RPC method.

Uses	Description
get_taxonomies()`wp-includes/taxonomy.php`	Retrieves a list of registered taxonomy names or objects.
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_taxonomy()`wp-includes/class-wp-xmlrpc-server.php`	Prepares taxonomy data for return in an XML-RPC object.
current_user_can()`wp-includes/capabilities.php`	Returns whether the current user has the specified capability.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
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.

Show 5 more Show less

Changelog

Version	Description
3.4.0	Introduced.

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

In this article