wp_xmlrpc_server::wp_getTerm() WordPress Method
The wp_xmlrpc_server::wp_getTerm() method is used to retrieve a single term from a WordPress site. This is useful for getting information about a specific term, such as its name, description, and so on.
wp_xmlrpc_server::wp_getTerm( array $args ) #
Retrieve a term.
Description
See also
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. - 'taxonomy'
(string) Taxonomy name. - 'term_id'
(string) Term ID.
- 'blog_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]; $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.getTerm', $args, $this ); 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 full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.4.0 | Introduced. |