W3cubDocs

/WordPress

wp_xmlrpc_server::wp_getTaxonomies( array $args )

Retrieve all taxonomies.

Description

Parameters

$args

(array) (Required) Method arguments. Note: arguments must be ordered as documented.

'blog_id'
(int) Blog ID (unused).
'username'
(string) Username.
'password'
(string) Password.
'filter'
(array) Optional. An array of arguments for retrieving taxonomies.
'fields'
(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

File: wp-includes/class-wp-xmlrpc-server.php

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

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

Uses

Uses	Description
wp-includes/capabilities.php: current_user_can()	Returns whether the current user has the specified capability.
wp-includes/taxonomy.php: get_taxonomies()	Retrieves a list of registered taxonomy names or objects.
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.
wp-includes/plugin.php: do_action()	Execute functions hooked on a specific action hook.
wp-includes/class-wp-xmlrpc-server.php: xmlrpc_default_taxonomy_fields	Filters the taxonomy query fields used by the given XML-RPC method.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::minimum_args()	Checks if the method received at least the minimum number of arguments.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_taxonomy()	Prepares taxonomy data for return in an XML-RPC object.
wp-includes/class-wp-xmlrpc-server.php: xmlrpc_call	Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::escape()	Escape string or array of strings for database.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::login()	Log user in.

Changelog

Version	Description
3.4.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_xmlrpc_server/wp_gettaxonomies