get_the_term_list

Advertisement

Summery Summery

Retrieve a post’s terms as a list with specified format.

Syntax Syntax

get_the_term_list( int $id, string $taxonomy, string $before = '', string $sep = '', string $after = '' )

Parameters Parameters

$id

(Required) Post ID.

$taxonomy

(Required) Taxonomy name.

$before

(Optional) Before list.

Default value: ''

$sep

(Optional) Separate items using this.

Default value: ''

$after

(Optional) After list.

Default value: ''

Return Return

(string|false|WP_Error) A list of terms on success, false if there are no terms, WP_Error on failure.

Source Source

File: wp-includes/category-template.php

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

/**
 * Retrieves a post's terms as a list with specified format.
 *

Advertisement

Changelog Changelog

Changelog
Version Description
2.5.0 Introduced.

Advertisement

Leave a Reply