WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Terms_Controller::get_term()

WP_REST_Terms_Controller::get_term( int $id ): WP_Term|WP_Error

In this article

Back to top

Get the term, if the ID is valid.

Parameters

$idintrequired
Supplied ID.

Return

WP_Term|WP_Error Term object if ID is valid, WP_Error otherwise.

Source

protected function get_term( $id ) {	$error = new WP_Error(	'rest_term_invalid',	__( 'Term does not exist.' ),	array( 'status' => 404 )	);	if ( ! $this->check_is_taxonomy_allowed( $this->taxonomy ) ) {	return $error;	}	if ( (int) $id <= 0 ) {	return $error;	}	$term = get_term( (int) $id, $this->taxonomy );	if ( empty( $term ) || $term->taxonomy !== $this->taxonomy ) {	return $error;	}	return $term; }

View all references View on Trac View on GitHub

UsesDescription
WP_REST_Terms_Controller::check_is_taxonomy_allowed()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Checks that the taxonomy is valid.

get_term()wp-includes/taxonomy.php

Gets all term data from database by term ID.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 1 moreShow less
Used byDescription
WP_REST_Menus_Controller::get_term()wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php

Gets the term, if the ID is valid.

WP_REST_Terms_Controller::delete_item()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Deletes a single term from a taxonomy.

WP_REST_Terms_Controller::get_item()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Gets a single term from a taxonomy.

WP_REST_Terms_Controller::update_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Checks if a request has access to update the specified term.

WP_REST_Terms_Controller::update_item()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Updates a single term from a taxonomy.

WP_REST_Terms_Controller::delete_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Checks if a request has access to delete the specified term.

WP_REST_Terms_Controller::get_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Checks if a request has access to read or edit the specified term.

Show 2 moreShow less

Changelog

VersionDescription
4.7.2Introduced.

User Contributed Notes

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