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

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

Contents

Description

Terms are linked to their respective term listing pages.

Top ↑

Parameters

$post_id

(int) (Required) Post ID.

$taxonomy

(string) (Required) Taxonomy name.

$before

(string) (Optional) String to use before the terms.

Default value: ''

$sep

(string) (Optional) String to use between the terms.

Default value: ''

$after

(string) (Optional) String to use after the terms.

Default value: ''

Top ↑

Return

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

Top ↑

Source

File: wp-includes/category-template.php 

function get_the_term_list( $post_id, $taxonomy, $before = '', $sep = '', $after = '' ) {
	$terms = get_the_terms( $post_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 hook name, `$taxonomy`, refers
	 * to the taxonomy slug.
	 *
	 * Possible hook names include:
	 *
	 *  - `term_links-category`
	 *  - `term_links-post_tag`
	 *  - `term_links-post_format`
	 *
	 * @since 2.5.0
	 *
	 * @param string[] $links An array of term links.
	 */
	$term_links = apply_filters( "term_links-{$taxonomy}", $links );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores

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

Expand full source code Collapse full source code View on Trac View on GitHub

Top ↑

Top ↑

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()

Retrieves 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()

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

Calls the callback functions that have been added to a filter hook.
wp-includes/load.php: is_wp_error()

Checks whether the given variable is a WordPress Error.
Show 1 more use Hide more uses

Top ↑

Used By

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

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

Retrieves the tags for a post formatted as a string.

Top ↑

Changelog

Changelog
Version Description
2.5.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: 5You must log in to vote on the helpfulness of this note
    Contributed by Ömür Yanıkoğlu —

    You can use this function with strip_tags function to print not linked term list:

    echo strip_tags( get_the_term_list( $post->ID, 'job_titles', '', ', ') )

    This prints something like this:

    Designer, Front-end Developer, Developer

  2. Skip to note 2 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>, ...
  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 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.