wp_xmlrpc_server::wp_getTerm( array $args )

Retrieve a term.

Description

See also

Parameters

$args

(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.
  • 'term_id'
    (string) Term ID.

Return

(array|IXR_Error) IXR_Error on failure, array on success, containing:

  • 'term_id'
  • 'name'
  • 'slug'
  • 'term_group'
  • 'term_taxonomy_id'
  • 'taxonomy'
  • 'description'
  • 'parent'
  • 'count'

Source

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

	public function wp_getTerm( $args ) {
		if ( ! $this->minimum_args( $args, 5 ) )
			return $this->error;

		$this->escape( $args );

		$username           = $args[1];
		$password           = $args[2];
		$taxonomy           = $args[3];
		$term_id            = (int) $args[4];

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

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

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

		$taxonomy = get_taxonomy( $taxonomy );

		$term = get_term( $term_id , $taxonomy->name, ARRAY_A );

		if ( is_wp_error( $term ) )
			return new IXR_Error( 500, $term->get_error_message() );

		if ( ! $term )
			return new IXR_Error( 404, __( 'Invalid term ID.' ) );

		if ( ! current_user_can( 'assign_term', $term_id ) ) {
			return new IXR_Error( 401, __( 'Sorry, you are not allowed to assign this term.' ) );
		}

		return $this->_prepare_term( $term );
	}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/capabilities.php: current_user_can()

Whether the current user has a specific capability.
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::escape()

Escape string or array of strings for database.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::login()

Log user in.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_term()

Prepares term 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/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/load.php: is_wp_error()

Check whether variable is a ClassicPress Error.
wp-includes/taxonomy.php: get_term()

Get all Term data from database by Term ID.
wp-includes/taxonomy.php: taxonomy_exists()

Checks that the taxonomy name exists.
wp-includes/taxonomy.php: get_taxonomy()

Retrieves the taxonomy object of $taxonomy.
Show 7 more uses Hide more uses

Changelog

Changelog
Version Description
WP-3.4.0 Introduced.