wp_xmlrpc_server::wp_getTerm( array $args )
Retrieves a term.
Description
See also
Parameters
- $args
-
(Required) Method arguments. Note: arguments must be ordered as documented.<br>
- (int) Blog ID (unused).<br>
- '1'
(string) Username.<br> - '2'
(string) Password.<br> - '3'
(string) Taxonomy name.<br> - '4'
(int) Term ID.<br>
Return
(array|IXR_Error) IXR_Error on failure, array on success, containing:<br>
- 'term_id'<br>
- 'name'<br>
- 'slug'<br>
- 'term_group'<br>
- 'term_taxonomy_id'<br>
- 'taxonomy'<br>
- 'description'<br>
- 'parent'<br>
- '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 );
}
Changelog
Version | Description |
---|---|
3.4.0 | Introduced. |