wpseek.com
A WordPress-centric search engine for devs and theme authors



get_the_term_list › WordPress Function

Since2.5.0
Deprecatedn/a
› get_the_term_list ( $post_id, $taxonomy, $before = '', $sep = '', $after = '' )
Parameters: (5)
  • (int) $post_id Post ID.
    Required: Yes
  • (string) $taxonomy Taxonomy name.
    Required: Yes
  • (string) $before Optional. String to use before the terms. Default empty.
    Required: No
    Default: (empty)
  • (string) $sep Optional. String to use between the terms. Default empty.
    Required: No
    Default: (empty)
  • (string) $after Optional. String to use after the terms. Default empty.
    Required: No
    Default: (empty)
Returns:
  • (string|false|WP_Error) A list of terms on success, false if there are no terms, WP_Error on failure.
Defined at:
Codex:

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

Terms are linked to their respective term listing pages.


Related Functions: get_the_terms, get_the_tag_list, get_the_category_list, get_the_permalink, get_edit_term_link

Source 

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