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

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

Contents

Description Description

Parameters Parameters

$id

(int) (Required) Post ID.

$taxonomy

(string) (Required) Taxonomy name.

$before

(string) (Optional) Before list.

Default value: ''

$sep

(string) (Optional) Separate items using this.

Default value: ''

$after

(string) (Optional) After list.

Default value: ''

Top ↑

Return Return

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

Top ↑

Source Source

File: wp-includes/category-template.php 

function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
	$terms = get_the_terms( $id, $taxonomy );

	if ( is_wp_error( $terms ) )
		return $terms;

	if ( empty( $terms ) )
		return false;

	$links = array();

	foreach ( $terms as $term ) {
		$link = get_term_link( $term, $taxonomy );
		if ( is_wp_error( $link ) ) {
			return $link;
		}
		$links[] = '<a href="' . esc_url( $link ) . '" rel="tag">' . $term->name . '</a>';
	}

	/**
	 * Filters the term links for a given taxonomy.
	 *
	 * The dynamic portion of the filter name, `$taxonomy`, refers
	 * to the taxonomy slug.
	 *
	 * @since 2.5.0
	 *
	 * @param array $links An array of term links.
	 */
	$term_links = apply_filters( "term_links-{$taxonomy}", $links );

	return $before . join( $sep, $term_links ) . $after;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/category-template.php: term_links-{$taxonomy}

Filters the term links for a given taxonomy.
wp-includes/category-template.php: get_the_terms()

Retrieve the terms of the taxonomy that are attached to the post.
wp-includes/formatting.php: esc_url()

Checks and cleans a URL.
wp-includes/taxonomy.php: get_term_link()

Generate a permalink for a taxonomy term archive.
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.
Show 1 more use Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/category-template.php: the_terms()

Display the terms in a list.
wp-includes/category-template.php: get_the_tag_list()

Retrieve the tags for a post formatted as a string.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 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 Codex —

    Basic Example

    Used inside the loop this outputs the terms from the people taxonomy for a specific post.

    <?php echo get_the_term_list( $post->ID, 'people', 'People: ', ', ' ); ?>

    This would return something like.

    People: <a href="person1">Person 1</a>, <a href="person2">Person 2</a>, ...
  2. Skip to note 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 Codex —

    Returning an HTML List

    Used inside the loop this outputs the terms from the styles taxonomy for a specific post as an (x)html list.

    echo get_the_term_list( $post->ID, 'styles', '<ul class="styles"><li>', ',</li><li>', '</li></ul>' );

    This would return something like.

    <ul class="styles">
    <li><a href="person1">Style 1</a>,</li> 
    <li><a href="person2">Style 2</a></li>
</ul>

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