get_the_term_list( int $post_id, string $taxonomy, string $before = '', string $sep = '', string $after = '' ): string|false|WP_Error

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

Contents

Description
Parameters
Return
Source
Hooks
Related
- Uses
- Used By
Changelog
User Contributed Notes
- Feedback

Description

Terms are linked to their respective term listing pages.

Parameters

$post_id int Required: Post ID.
$taxonomy string Required: Taxonomy name.
$before string Optional: String to use before the terms.

Default: ''
$sep string Optional: String to use between the terms.

Default: ''
$after string Optional: String to use after the terms.

Default: ''

Return

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

Source

File: wp-includes/category-template.php. View all references

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

View on Trac View on GitHub

Hooks

apply_filters( "term_links-{$taxonomy}", string[] $links )

Filters the term links for a given taxonomy.

Uses

Uses
Uses	Description
get_the_terms() wp-includes/category-template.php	Retrieves the terms of the taxonomy that are attached to the post.
get_term_link() wp-includes/taxonomy.php	Generates a permalink for a taxonomy term archive.
esc_url() wp-includes/formatting.php	Checks and cleans a URL.
apply_filters() wp-includes/plugin.php	Calls the callback functions that have been added to a filter hook.
is_wp_error() wp-includes/load.php	Checks whether the given variable is a WordPress Error.

Show 3 more uses Hide more uses

Used By

Used By
Used By	Description
the_terms() wp-includes/category-template.php	Displays the terms for a post in a list.
get_the_tag_list() wp-includes/category-template.php	Retrieves the tags for a post formatted as a string.

Changelog

Changelog
Version	Description
2.5.0	Introduced.

User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note

Contributed by Ömür Yanıkoğlu — 4 years ago
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
Top ↑
Feedback
- WordPress coding standards suggest that instead of `strip_tags` we should use the more comprehensive `wp_strip_all_tags` instead. — By hanopcan — 2 years ago
Log in to add feedback
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 — 7 years ago
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>, ...
```
Log in to add feedback
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 — 7 years ago
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>
```
Log in to add feedback

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