wp_get_post_terms( int $post_id, string|string[] $taxonomy = 'post_tag', array $args = array() ): array|WP_Error

Retrieves the terms for a post.

Contents

Parameters

$post_id int Optional
The Post ID. Does not default to the ID of the global $post. Default 0.
$taxonomy string|string[] Optional
The taxonomy slug or array of slugs for which to retrieve terms. Default 'post_tag'.

Default: 'post_tag'

$args array Optional
Term query parameters. See WP_Term_Query::__construct() for supported arguments.
  • fields string
    Term fields to retrieve. Default 'all'.
More Arguments from WP_Term_Query::__construct( ... $query ) Array or query string of term query parameters.
  • taxonomy string|string[]
    Taxonomy name, or array of taxonomy names, to which results should be limited.
  • object_ids int|int[]
    Object ID, or array of object IDs. Results will be limited to terms associated with these objects.
  • orderby string
    Field(s) to order terms by. Accepts:
    • Term fields ('name', 'slug', 'term_group', 'term_id', 'id', 'description', 'parent', 'term_order'). Unless $object_ids is not empty, 'term_order' is treated the same as 'term_id'.
    • 'count' to use the number of objects associated with the term.
    • 'include' to match the 'order' of the $include param.
    • 'slug__in' to match the 'order' of the $slug param.
    • 'meta_value'
    • 'meta_value_num'.
    • The value of $meta_key.
    • The array keys of $meta_query.
    • 'none' to omit the ORDER BY clause.
    Default 'name'.
  • order string
    Whether to order terms in ascending or descending order.
    Accepts 'ASC' (ascending) or 'DESC' (descending).
    Default 'ASC'.
  • hide_empty bool|int
    Whether to hide terms not assigned to any posts. Accepts 1|true or 0|false. Default 1|true.
  • include int[]|string
    Array or comma/space-separated string of term IDs to include.
    Default empty array.
  • exclude int[]|string
    Array or comma/space-separated string of term IDs to exclude.
    If $include is non-empty, $exclude is ignored.
    Default empty array.
  • exclude_tree int[]|string
    Array or comma/space-separated string of term IDs to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array.
  • number int|string
    Maximum number of terms to return. Accepts ''|0 (all) or any positive number. Default ''|0 (all). Note that $number may not return accurate results when coupled with $object_ids.
    See #41796 for details.
  • offset int
    The number by which to offset the terms query.
  • fields string
    Term fields to query for. Accepts:
    • 'all' Returns an array of complete term objects (WP_Term[]).
    • 'all_with_object_id' Returns an array of term objects with the 'object_id' param (WP_Term[]). Works only when the $object_ids parameter is populated.
    • 'ids' Returns an array of term IDs (int[]).
    • 'tt_ids' Returns an array of term taxonomy IDs (int[]).
    • 'names' Returns an array of term names (string[]).
    • 'slugs' Returns an array of term slugs (string[]).
    • 'count' Returns the number of matching terms (int).
    • 'id=>parent' Returns an associative array of parent term IDs, keyed by term ID (int[]).
    • 'id=>name' Returns an associative array of term names, keyed by term ID (string[]).
    • 'id=>slug' Returns an associative array of term slugs, keyed by term ID (string[]).
    Default 'all'.
  • count bool
    Whether to return a term count. If true, will take precedence over $fields. Default false.
  • name string|string[]
    Name or array of names to return term(s) for.
  • slug string|string[]
    Slug or array of slugs to return term(s) for.
  • term_taxonomy_id int|int[]
    Term taxonomy ID, or array of term taxonomy IDs, to match when querying terms.
  • hierarchical bool
    Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true.
  • search string
    Search criteria to match terms. Will be SQL-formatted with wildcards before and after.
  • name__like string
    Retrieve terms with criteria by which a term is LIKE $name__like.
  • description__like string
    Retrieve terms where the description is LIKE $description__like.
  • pad_counts bool
    Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false.
  • get string
    Whether to return terms regardless of ancestry or whether the terms are empty. Accepts 'all' or '' (disabled). Default ''.
  • child_of int
    Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0.
  • parent int
    Parent term ID to retrieve direct-child terms of.
  • childless bool
    True to limit results to terms that have no children.
    This parameter has no effect on non-hierarchical taxonomies.
    Default false.
  • cache_domain string
    Unique cache key to be produced when this query is stored in an object cache. Default 'core'.
  • cache_results bool
    Whether to cache term information. Default true.
  • update_term_meta_cache bool
    Whether to prime meta caches for matched terms. Default true.
  • meta_key string|string[]
    Meta key or keys to filter by.
  • meta_value string|string[]
    Meta value or values to filter by.
  • meta_compare string
    MySQL operator used for comparing the meta value.
    See WP_Meta_Query::__construct() for accepted values and default value.
  • meta_compare_key string
    MySQL operator used for comparing the meta key.
    See WP_Meta_Query::__construct() for accepted values and default value.
  • meta_type string
    MySQL data type that the meta_value column will be CAST to for comparisons.
    See WP_Meta_Query::__construct() for accepted values and default value.
  • meta_type_key string
    MySQL data type that the meta_key column will be CAST to for comparisons.
    See WP_Meta_Query::__construct() for accepted values and default value.
  • meta_query array
    An associative array of WP_Meta_Query arguments.
    See WP_Meta_Query::__construct() for accepted values.

Default: array()

Top ↑

Return

array|WP_Error Array of WP_Term objects on success or empty array if no terms were found.
WP_Error object if $taxonomy doesn't exist.

Top ↑

Source

File: wp-includes/post.php. View all references 

function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() ) {
	$post_id = (int) $post_id;

	$defaults = array( 'fields' => 'all' );
	$args     = wp_parse_args( $args, $defaults );

	$tags = wp_get_object_terms( $post_id, $taxonomy, $args );

	return $tags;
}

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
wp_get_object_terms() wp-includes/taxonomy.php

Retrieves the terms associated with the given object(s), in the supplied taxonomies.
wp_parse_args() wp-includes/functions.php

Merges user defined arguments into defaults array.

Top ↑

Changelog

Changelog
Version Description
2.8.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 14You must log in to vote on the helpfulness of this note
    Contributed by Dustin Falgout —

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

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

    Examples

    //Returns All Term Items for "my_taxonomy".
$term_list = wp_get_post_terms( $post->ID, 'my_taxonomy', array( 'fields' => 'all' ) );
print_r( $term_list );

// Returns Array of Term Names for "my_taxonomy".
$term_list = wp_get_post_terms( $post->ID, 'my_taxonomy', array( 'fields' => 'names' ) );
print_r( $term_list );

// Returns Array of Term ID's for "my_taxonomy".
$term_list = wp_get_post_terms( $post->ID, 'my_taxonomy', array( 'fields' => 'ids' ) );
print_r( $term_list );
  3. Skip to note 3 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 tradesouthwest —

    Get term category to only run function if the post (CPT) has that category:

    /**
 * Get category and add text to that page, only.
 * 
 * @param  string $terms Get post terms
 * @return string        Text
 */
function wpdocs_additional_measurements() {
     global $post;

    $innertext = "Hemmed tarps have seatbelt material woven into the hems.";
    $terms = wp_get_post_terms( $post->ID, 'product_cat' );

    foreach ( $terms as $term ) {
        $categories[] = $term->slug;
    }
            
    // Look for term/category by slug	
    if ( in_array( 'custom-tarps', $categories ) ) {
        printf( '<p>%s</p>',
                esc_html__( $innertext, 'woocommerce' )
        );
   }
        
} 
add_action( 'woocommerce_before_add_to_cart_button', 'wpdocs_additional_measurements', 9 );

    Use curly brackets recommended but not needed on one expression of foreach

  4. Skip to note 4 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Mehedi Foysal —

    Get all taxonomy slug of a post

    function post_taxonomy_slug_array( $tax_name = 'category' ) {

    $terms = wp_get_post_terms( get_the_ID(), $tax_name, array( "fields" => "slugs" ) );
    if ( ! empty( $terms ) && ! is_wp_error( $terms ) ) {

        $term_array = array();

        foreach ( $terms as $term ) {
            $term_array[] = $term;
        }

        return $term_array;
    }

    return '';
}
  5. Skip to note 5 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by awaismushtaq —

    You can get the taxonomy terms HTML using this function am_get_post_term

    function am_get_post_terms( $post_id = 0, $taxonomy = 'category', $custom_html = ['ul','li','a'] ) 
{
	$post_terms = wp_get_post_terms( $post_id, $taxonomy );

	$custom_html[0] = isset($custom_html[0]) ? $custom_html[0] : 'ul';
	$custom_html[1] = isset($custom_html[1]) ? $custom_html[1] : 'li';
	$custom_html[2] = isset($custom_html[2]) ? $custom_html[2] : 'a'; 

	$post_term_html = '';
	$post_term_html .= '<' . $custom_html[0] . '>';
	foreach( $post_terms as $p_term ) {
		$post_term_html .= '<' . $custom_html[1] . '><' . $custom_html[2] . ' href="'. get_term_link( $p_term->term_id, $taxonomy ) .'">'. $p_term->name .'</' . $custom_html[2]  . '></' . $custom_html[1] . '>';
	}
	$post_term_html .= '</' . $custom_html[0] . '>';

	return $post_term_html;

}

Call the function in single.php file work for all CPT:

[php]echo am_get_post_terms( get_the_ID(), 'category',['div','span','a'] );

    [/php]

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