Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Taxonomy: Add template parameter for customizing term display in lists #8393

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
+106 −23
Open

Taxonomy: Add template parameter for customizing term display in lists #8393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 32 additions & 23 deletions src/wp-includes/category-template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1194,16 +1194,19 @@ function get_the_tags( $post = 0 ) {
* Retrieves the tags for a post formatted as a string.
*
* @since 2.3.0
*
* @param string $before Optional. String to use before the tags. Default empty.
* @param string $sep Optional. String to use between the tags. Default empty.
* @param string $after Optional. String to use after the tags. Default empty.
* @param int $post_id Optional. Post ID. Defaults to the current post ID.
* @since 6.8.0 Added the `$tag_template` parameter.
*
* @param string $before Optional. String to use before the tags. Default empty.
* @param string $sep Optional. String to use between the tags. Default empty.
* @param string $after Optional. String to use after the tags. Default empty.
* @param int $post_id Optional. Post ID. Defaults to the current post ID.
* @param string $tag_template Optional. Template for displaying a single tag in the list.
* Default '<a href="%1$s" rel="tag">%2$s</a>'.
* @return string|false|WP_Error A list of tags on success, false if there are no terms,
* WP_Error on failure.
*/
function get_the_tag_list( $before = '', $sep = '', $after = '', $post_id = 0 ) {
$tag_list = get_the_term_list( $post_id, 'post_tag', $before, $sep, $after );
function get_the_tag_list( $before = '', $sep = '', $after = '', $post_id = 0, $tag_template = '<a href="%1$s" rel="tag">%2$s</a>' ) {
$tag_list = get_the_term_list( $post_id, 'post_tag', $before, $sep, $after, $tag_template );

/**
* Filters the tags list for a given post.
Expand Down Expand Up @@ -1326,16 +1329,19 @@ function get_the_terms( $post, $taxonomy ) {
* Terms are linked to their respective term listing pages.
*
* @since 2.5.0
*
* @param int $post_id Post ID.
* @param string $taxonomy Taxonomy name.
* @param string $before Optional. String to use before the terms. Default empty.
* @param string $sep Optional. String to use between the terms. Default empty.
* @param string $after Optional. String to use after the terms. Default empty.
* @since 6.8.0 Added the `$term_template` parameter.
*
* @param int $post_id Post ID.
* @param string $taxonomy Taxonomy name.
* @param string $before Optional. String to use before the terms. Default empty.
* @param string $sep Optional. String to use between the terms. Default empty.
* @param string $after Optional. String to use after the terms. Default empty.
* @param string $term_template Optional. Template for displaying a single term in the list.
* Default '<a href="%1$s" rel="tag">%2$s</a>'.
* @return string|false|WP_Error A list of terms on success, false if there are no terms,
* WP_Error on failure.
*/
function get_the_term_list( $post_id, $taxonomy, $before = '', $sep = '', $after = '' ) {
function get_the_term_list( $post_id, $taxonomy, $before = '', $sep = '', $after = '', $term_template = '<a href="%1$s" rel="tag">%2$s</a>' ) {
$terms = get_the_terms( $post_id, $taxonomy );

if ( is_wp_error( $terms ) ) {
Expand All @@ -1353,7 +1359,7 @@ function get_the_term_list( $post_id, $taxonomy, $before = '', $sep = '', $after
if ( is_wp_error( $link ) ) {
return $link;
}
$links[] = '<a href="' . esc_url( $link ) . '" rel="tag">' . $term->name . '</a>';
$links[] = sprintf( $term_template, esc_url( $link ), esc_html( $term->name ) );
}

/**
Expand Down Expand Up @@ -1446,16 +1452,19 @@ function get_term_parents_list( $term_id, $taxonomy, $args = array() ) {
* Displays the terms for a post in a list.
*
* @since 2.5.0
*
* @param int $post_id Post ID.
* @param string $taxonomy Taxonomy name.
* @param string $before Optional. String to use before the terms. Default empty.
* @param string $sep Optional. String to use between the terms. Default ', '.
* @param string $after Optional. String to use after the terms. Default empty.
* @since 6.8.0 Added the `$term_template` parameter.
*
* @param int $post_id Post ID.
* @param string $taxonomy Taxonomy name.
* @param string $before Optional. String to use before the terms. Default empty.
* @param string $sep Optional. String to use between the terms. Default empty.
* @param string $after Optional. String to use after the terms. Default empty.
* @param string $term_template Optional. Template for displaying a single term in the list.
* Default '<a href="%1$s" rel="tag">%2$s</a>'.
* @return void|false Void on success, false on failure.
*/
function the_terms( $post_id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
$term_list = get_the_term_list( $post_id, $taxonomy, $before, $sep, $after );
function the_terms( $post_id = 0, $taxonomy, $before = '', $sep = '', $after = '', $term_template = '<a href="%1$s" rel="tag">%2$s</a>' ) {
$term_list = get_the_term_list( $post_id, $taxonomy, $before, $sep, $after, $term_template );

if ( is_wp_error( $term_list ) ) {
return false;
Expand Down
74 changes: 74 additions & 0 deletions tests/phpunit/tests/term/termTemplate.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<?php
/**
* @group taxonomy
* @group term
*/
class Tests_Term_Template extends WP_UnitTestCase {
protected static $post_id;
protected static $term_id;
protected static $second_term_id;

public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
self::$post_id = $factory->post->create();
self::$term_id = $factory->term->create(
array(
'taxonomy' => 'category',
'name' => 'Test Category',
)
);
self::$second_term_id = $factory->term->create(
array(
'taxonomy' => 'category',
'name' => 'Another Category',
)
);
wp_set_post_terms( self::$post_id, array( self::$term_id, self::$second_term_id ), 'category' );
}

/**
* @ticket 30705
*/
public function test_get_the_term_list_default_template() {
$list = get_the_term_list( self::$post_id, 'category', '', ', ', '' );

$this->assertMatchesRegularExpression(
'/<a href="[^"]*" rel="tag">Test Category<\/a>/',
$list
);
$this->assertMatchesRegularExpression(
'/<a href="[^"]*" rel="tag">Another Category<\/a>/',
$list
);
}

/**
* @ticket 30705
*/
public function test_get_the_term_list_custom_template() {
$custom_template = '<span class="term"><a href="%1$s">%2$s</a></span>';
$list = get_the_term_list( self::$post_id, 'category', '', ', ', '', $custom_template );

$this->assertMatchesRegularExpression(
'/<span class="term"><a href="[^"]*">Test Category<\/a><\/span>/',
$list
);
}

/**
* @ticket 30705
*/
public function test_get_the_term_list_escaping() {
$unsafe_term_id = self::factory()->term->create(
array(
'taxonomy' => 'category',
'name' => 'Test & Category <script>alert("xss")</script>',
)
);
wp_set_post_terms( self::$post_id, array( $unsafe_term_id ), 'category' );

$list = get_the_term_list( self::$post_id, 'category', '', ', ', '' );

$this->assertStringContainsString( 'Test &amp; Category', $list );
$this->assertStringNotContainsString( '<script>', $list );
}
}
Loading