get_the_terms
Retrieve the terms of the taxonomy that are attached to the post.
Description
Returns (array|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.
Parameters (2)
- 0. $post (int|object)
- Post ID or object.
- 1. $taxonomy (string)
- Taxonomy name.
Usage
if ( !function_exists( 'get_the_terms' ) ) { require_once ABSPATH . WPINC . '/category-template.php'; } // Post ID or object. $post = null; // Taxonomy name. $taxonomy = ''; // NOTICE! Understand what this does before running. $result = get_the_terms($post, $taxonomy);
Defined (1)
The function is defined in the following location(s).
- /wp-includes/category-template.php
- function get_the_terms( $post, $taxonomy ) {
- if ( ! $post = get_post( $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 array|WP_Error $terms List 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;
- }