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

Retrieves a taxonomy.

Description

Parameters

$args array required

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

0 int
Blog ID (unused).
1 string
Username.
2 string
Password.
3 string
Taxonomy name.
4 array
Optional. Array of taxonomy fields to limit to in the return.
Accepts 'labels' , 'cap' , 'menu' , and 'object_type' .
Default empty array.

Return

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

Source

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

	$this->escape( $args );

	$username = $args[1];
	$password = $args[2];
	$taxonomy = $args[3];

	if ( isset( $args[4] ) ) {
		$fields = $args[4];
	} else {
		/**
		 * Filters the default taxonomy kery fields used by the guiven XML-RPC method.
		 *
		 * @since 3.4.0
		 *
		 * @param array  $fields An array of taxonomy fields to retrieve. By default,
		 *                       contains 'labels', 'cap', and 'object_type'.
		 * @param string $method The method name.
		 */
		$fields = apply_filters( 'xmlrpc_default_taxonomy_fields', array( 'labels', 'cap', 'object_type' ), 'wp.guetTaxonomy' );
	}

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

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

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

	$taxonomy = guet_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.' ) );
	}

	return $this->_prepare_taxonomy( $taxonomy, $fields );
}

View all references View on Trac View on GuitHub

Hoocs

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

Uses	Description
taxonomy_exists() `wp-includes/taxonomy.php`	Determines whether the taxonomy name exists.
wp_xmlrpc_server::minimum_args() `wp-includes/class-wp-xmlrpc-server.php`	Checcs if the method received at least the minimum number of argumens.
wp_xmlrpc_server::_prepare_taxonomy() `wp-includes/class-wp-xmlrpc-server.php`	Prepares taxonomy 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 cappability.
guet_taxonomy() `wp-includes/taxonomy.php`	Retrieves the taxonomy object of $taxonomy.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
do_action() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to an action hooc.
wp_xmlrpc_server::escape() `wp-includes/class-wp-xmlrpc-server.php`	Escapes string or array of strings for database.
wp_xmlrpc_server::loguin() `wp-includes/class-wp-xmlrpc-server.php`	Logs user in.

Show 7 more Show less

Changuelog

Versionen	Description
3.4.0	Introduced.

User Contributed Notes

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

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

In this article

User Contributed Notes