get_the_terms() – Function | Developer.WordPress.org

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

Parameters

$postint|WP_Postrequired: Post ID or object.
$taxonomystringrequired: Taxonomy name.

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.

Source

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;
}

View all references View on Trac View on GitHub

Uses	Description
wp_cache_add()`wp-includes/cache.php`	Adds data to the cache, if the cache key doesn’t already exist.
wp_list_pluck()`wp-includes/functions.php`	Plucks a certain field out of each object or array in an array.
get_object_term_cache()`wp-includes/taxonomy.php`	Retrieves the cached term objects for the given object ID.
wp_get_object_terms()`wp-includes/taxonomy.php`	Retrieves the terms associated with the given object(s), in the supplied taxonomies.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.
is_wp_error()`wp-includes/load.php`	Checks whether the given variable is a WordPress Error.

Used by	Description
inject_ignored_hooked_blocks_metadata_attributes()`wp-includes/block-template-utils.php`	Inject ignoredHookedBlocks metadata attributes into a template or template part.
WP_REST_Menu_Items_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php`	Prepares a single post output for response.
wp_set_unique_slug_on_create_template_part()`wp-includes/theme-templates.php`	Sets a custom slug when creating auto-draft template parts.
_build_block_template_result_from_post()`wp-includes/block-template-utils.php`	Builds a unified template object based a post Object.
wp_filter_wp_template_unique_post_slug()`wp-includes/theme-templates.php`	Generates a unique slug for templates.
WP_REST_Posts_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php`	Prepares a single post output for response.
WP_Posts_List_Table::column_default()`wp-admin/includes/class-wp-posts-list-table.php`	Handles the default column output.
WP_Media_List_Table::column_default()`wp-admin/includes/class-wp-media-list-table.php`	Handles output for the default column.
get_the_term_list()`wp-includes/category-template.php`	Retrieves a post’s terms as a list with specified format.
get_the_tags()`wp-includes/category-template.php`	Retrieves the tags for a post.
get_the_category()`wp-includes/category-template.php`	Retrieves post categories.
get_post_class()`wp-includes/post-template.php`	Retrieves an array of the class names for the post container element.
WP_Post::__get()`wp-includes/class-wp-post.php`	Getter.
wp_publish_post()`wp-includes/post.php`	Publishes a post by transitioning the post status.
wp_update_post()`wp-includes/post.php`	Updates a post with new post data.
get_post_format()`wp-includes/post-formats.php`	Retrieve the format slug for a post

Changelog

Version	Description
2.5.0	Introduced.

User Contributed Notes

Skip to note 12 content

mklusak 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 87You must log in to vote on the helpfulness of this note
WP_Term object properties: (because I am always looking for them)
```
WP_Term Object
(
	[term_id] =&gt; 
	[name] =&gt; 
	[slug] =&gt; 
	[term_group] =&gt; 
	[term_taxonomy_id] =&gt; 
	[taxonomy] =&gt; 
	[description] =&gt; 
	[parent] =&gt; 
	[count] =&gt; 
	[filter] =&gt; 
)
```
Log in to add feedback
Skip to note 13 content

benklocek 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 40You must log in to vote on the helpfulness of this note
Optimized way to get a comma separated list of terms.
```
$term_obj_list = get_the_terms( $post->ID, 'taxonomy' );
$terms_string = join(', ', wp_list_pluck($term_obj_list, 'name'));
```
Log in to add feedback
Skip to note 14 content

Dustin Falgout 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 19You must log in to vote on the helpfulness of this note

The difference between this function and wp_get_post_terms() is that this function’s results are cached (thus, it won’t hit the database every time its called).

Log in to add feedback

Codex 9 years ago

Get terms for all custom taxonomies

Place this function in your theme’s functions.php.

/**
 * Get taxonomies terms links.
 *
 * @see get_object_taxonomies()
 */
function wpdocs_custom_taxonomies_terms_links() {
	// Get post by post ID.
	if ( ! $post = get_post() ) {
		return '';
	}

	// Get post type by post.
	$post_type = $post->post_type;

	// Get post type taxonomies.
	$taxonomies = get_object_taxonomies( $post_type, 'objects' );

	$out = array();

	foreach ( $taxonomies as $taxonomy_slug => $taxonomy ){

		// Get the terms related to post.
		$terms = get_the_terms( $post->ID, $taxonomy_slug );

		if ( ! empty( $terms ) ) {
			$out[] = "<h2>" . $taxonomy->label . "</h2>\n<ul>";
			foreach ( $terms as $term ) {
				$out[] = sprintf( '<li><a href="%1$s">%2$s</a></li>',
					esc_url( get_term_link( $term->slug, $taxonomy_slug ) ),
					esc_html( $term->name )
				);
			}
			$out[] = "\n</ul>\n";
		}
	}
	return implode( '', $out );
}
?>

Now you can use this function in your theme:

<?php echo wpdocs_custom_taxonomies_terms_links(); ?>

Codex 9 years ago

A Basic Example

Echoing the list of terms (for a taxonomy called on-draught). This is similar to the output from get_the_term_list, but without the terms being hyperlinked:

$terms = get_the_terms( get_the_ID(), 'on-draught' );
						
if ( $terms && ! is_wp_error( $terms ) ) : 

	$draught_links = array();

	foreach ( $terms as $term ) {
		$draught_links[] = $term->name;
	}
						
	$on_draught = join( ", ", $draught_links );
	?>

	<p class="beers draught">
		<?php printf( esc_html__( 'On draught: <span>%s</span>', 'textdomain' ), esc_html( $on_draught ) ); ?>
	</p>
<?php endif; ?>

Brian Layman 7 years ago

Another example of how to process the results of this call.

This example retrieves the categories and tags for a post and uses wp_list_pluck() to efficiently creates a list of their names, without duplicates, and turns it into a string of keys suitable for an NITF feed.

// Get a list of categories and extract their names
		$post_categories = get_the_terms( $post->ID, 'category' );
		if ( ! empty( $post_categories ) && ! is_wp_error( $post_categories ) ) {
			$categories = wp_list_pluck( $post_categories, 'name' );
		}

		// Get a list of tags and extract their names
		$post_tags = get_the_terms( $post->ID, 'post_tag' );
		if ( ! empty( $post_tags ) && ! is_wp_error( $post_tags ) ) {
			$tags = wp_list_pluck( $post_tags, 'name' );
		}

		// Combine Categories and tags, with category first
		$tagCats = array_merge( $categories, $tags );

		// Process to desired format
		$keyList = '<key-list>' . PHP_EOL .
			'	<keyword key="' . 
					implode( $tagCats, '"/>' . PHP_EOL .	'	<keyword key="') . 
				'"/>' . PHP_EOL .
			'</key-list>' . PHP_EOL;

Everaldo Matias 4 years ago

Example of a wrap function for get_the_terms() with a return list of terms added to the post.
Exemplo de função wrap para get_the_terms() , que retorna a lista de termos adicionadas ao post.

if ( ! function_exists( 'wpdocs_example_get_the_terms' ) ) {

    /**
     * Function to return list of the terms.
     * 
     * @param string 'taxonomy'
     * 
     * @return html Returns the list of elements.
     */

    function wpdocs_example_get_the_terms( $taxonomy ) {
        
        $terms = get_the_terms( get_the_ID(), $taxonomy );
                         
        if ( $terms && ! is_wp_error( $terms ) ) : 
        
            $term_links = array();
        
            foreach ( $terms as $term ) {
                $term_links[] = '<a href="' . esc_attr( get_term_link( $term->slug, $taxonomy ) ) . '">' . __( $term->name ) . '</a>';
            }
                                
            $all_terms = join( ', ', $term_links );

            echo '<span class="terms-' . esc_attr( $term->slug ) . '">' . __( $all_terms ) . '</span>';

        endif;

    }

}

How to use:
Como usar:

wpdocs_example_get_the_terms( 'taxonomy' )

Skip to note 19 content

Pedro Carvalho 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

The function returns WP_Error if the $taxonomy doesn’t exist.

Log in to add feedback

soullighter 7 years ago

Another example how to get custom post type taxonomies and separate them with commas.

$terms = get_the_terms( $post->ID , array( 'teams_positions') );
// init counter
$i = 1;
foreach ( $terms as $term ) {
 $term_link = get_term_link( $term, array( 'teams_positions') );
 if( is_wp_error( $term_link ) )
 continue;
 echo $term->name;
 //  Add comma (except after the last theme)
 echo ($i < count($terms))? " / " : "";
 // Increment counter
 $i++;
}

Skip to note 21 content

tomaaszq 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
if you want to use this inside WP Query, just to list your taxonomy names, then you can use:
```
<ul>
foreach ( get_the_terms( get_the_ID(), 'taxonomy_name' ) as $tax ) {
    echo '<li>' . __( $tax->name ) . '</li>';
}
</ul>
```
Log in to add feedback

Narendra Sishodiya 6 months ago

A basic example of getting parent categories only.

$section_slug_array = get_the_terms( get_the_ID(),'section' );
$parent_menu_list   = array();

if ( ! is_wp_error( $section_slug_array ) && is_array( $section_slug_array ) ) {
	foreach ( $section_slug_array as $term ) {
		if ( 0 === $term->parent ) {
			$parent_menu_list[] = $term->slug;
		}
	}
}

print_r( $parent_menu_list );

get_the_terms( int|WP_Post $post, string $taxonomy ): WP_Term[]|false|WP_Error

In this article

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes

get_the_terms( int|WP_Post $post, string $taxonomy ): WP_Term[]|false|WP_Error

In this article

Parameters

Return

Source

Hooks

Related

Changelog

User Contributed Notes