get_the_terms() WordPress Function

The get_the_terms() function is used to retrieve the terms for a given post. This function accepts two parameters: the post ID and the taxonomy. The post ID is the ID of the post for which you want to retrieve the terms. The taxonomy is the name of the taxonomy for which you want to retrieve the terms.

get_the_terms( int|WP_Post $post, string $taxonomy ) #

Retrieves the terms of the taxonomy that are attached to the post.


Parameters

$post

(int|WP_Post)(Required)Post ID or object.

$taxonomy

(string)(Required)Taxonomy name.


Top ↑

Return

(WP_Term[]|false|WP_Error) Array of WP_Term objects on success, false if there are no terms or the post does not exist, WP_Error on failure.


Top ↑

Source

File: wp-includes/category-template.php

function get_the_terms( $post, $taxonomy ) {
	$post = get_post( $post );
	if ( ! $post ) {
		return false;
	}

	$terms = get_object_term_cache( $post->ID, $taxonomy );
	if ( false === $terms ) {
		$terms = wp_get_object_terms( $post->ID, $taxonomy );
		if ( ! is_wp_error( $terms ) ) {
			$term_ids = wp_list_pluck( $terms, 'term_id' );
			wp_cache_add( $post->ID, $term_ids, $taxonomy . '_relationships' );
		}
	}

	/**
	 * Filters the list of terms attached to the given post.
	 *
	 * @since 3.1.0
	 *
	 * @param WP_Term[]|WP_Error $terms    Array of attached terms, or WP_Error on failure.
	 * @param int                $post_id  Post ID.
	 * @param string             $taxonomy Name of the taxonomy.
	 */
	$terms = apply_filters( 'get_the_terms', $terms, $post->ID, $taxonomy );

	if ( empty( $terms ) ) {
		return false;
	}

	return $terms;
}


Top ↑

Changelog

Changelog
VersionDescription
2.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.