get_the_tag_list( string $before = '', string $sep = '', string $after = '', int $post_id )
Retrieves the tags for a post formatted as a string.
Parameters
- $before
-
(string) (Optional) String to use before the tags.
Default value: ''
- $sep
-
(string) (Optional) String to use between the tags.
Default value: ''
- $after
-
(string) (Optional) String to use after the tags.
Default value: ''
- $post_id
-
(int) (Optional) Post ID. Defaults to the current post ID.
Return
(string|false|WP_Error) A list of tags on success, false if there are no terms, WP_Error on failure.
More Information
This function generates a HTML string of the tags associated with the current post. The name of each tag will be linked to the relevant ‘tag’ page. You can tell the function to put a string before and after all the tags, and in between each tag. Differently from get_the_category_list, this tag must be used inside The Loop.
Source
File: wp-includes/category-template.php
function get_the_tag_list( $before = '', $sep = '', $after = '', $post_id = 0 ) { $tag_list = get_the_term_list( $post_id, 'post_tag', $before, $sep, $after ); /** * Filters the tags list for a given post. * * @since 2.3.0 * * @param string $tag_list List of tags. * @param string $before String to use before the tags. * @param string $sep String to use between the tags. * @param string $after String to use after the tags. * @param int $post_id Post ID. */ return apply_filters( 'the_tags', $tag_list, $before, $sep, $after, $post_id ); }
Changelog
Version | Description |
---|---|
2.3.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_the_tag_list