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.
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
(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
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 WP-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;
}
Changelog
Version | Description |
---|---|
WP-2.5.0 | Introduced. |