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

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

Contents

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. View all references 

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 on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
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.
Show 3 more uses Hide more uses

Top ↑

Used By

Used By
Used By Description
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
Show 10 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

User Contributed Notes

  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 16You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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(); ?>
  5. Skip to note 5 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 13You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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; ?>
  6. Skip to note 6 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
    Contributed by Brian Layman —

    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;
  7. Skip to note 7 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
    Contributed by Everaldo Matias —

    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' )
  9. Skip to note 9 content
    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
    Contributed by soullighter —

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

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