Changeset 30209

Timestamp:

11/03/2014 06:48:42 PM (10 years ago)

Author:

boonebgorges

Message:

Introduce term_template param to get_the_taxonomies().

This parameter allows theme and plugin authors to specify the formatting they
would like on the term links as they are parsed into the taxonomy list.

Props hereswhatidid, dlh, davidjlaietta.
See #27238.

Location:

trunk

Files:

• src/wp-includes/taxonomy.php (modified) (5 diffs)
• tests/phpunit/tests/taxonomy.php (modified) (2 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -4132 +4132 @@
  * display the taxonomies for a specific post.
  *
- * The available defaults are:
- * 'post' : default is 0. The post ID to get taxonomies of.
- * 'before' : default is empty string. Display before taxonomies list.
- * 'sep' : default is empty string. Separate every taxonomy with value in this.
- * 'after' : default is empty string. Display this after the taxonomies list.
- * 'template' : The template to use for displaying the taxonomy terms.
- *
  * @since 2.5.0
  *
- * @param array $args Override the defaults.
+ * @param array $args {
+ *     Arguments about which post to use and how to format the output.
+ *
+ *     @type  int|WP_Post $post          Post ID or object to get taxonomies of. Default current post.
+ *     @type  string      $before        Displays before the taxonomies. Default empty string.
+ *     @type  string      $sep           Separates each taxonomy. Default is a space.
+ *     @type  string      $after         Displays after the taxonomies. Default empty string.
+ *     @type  string      $template      Template for displaying a taxonomy label and list of
+ *                                       terms. Default is "Label: Terms."
+ *     @type  string      $term_template Template for displaying a single term in the list.
+ *                                       Default is the term name linked to its archive.
+ * }
  */
 function the_taxonomies( $args = array() ) {
@@ -4149 +4153 @@
         'sep' => ' ',
         'after' => '',
-        /* translators: %s: taxonomy label, %l: list of term links */
-        'template' => __( '%s: %l.' )
+        /* translators: %s: taxonomy label, %l: list of terms formatted as per $term_template */
+        'template' => __( '%s: %l.' ),
+        /* translators: %1$s: term link, %2$s: term name */
+        'term_template' => '<a href="%1$s">%2$s</a>',
     );
 
@@ -4174 +4180 @@
 
     $args = wp_parse_args( $args, array(
-        /* translators: %s: taxonomy label, %l: list of term links */
+        /* translators: %s: taxonomy label, %l: list of terms formatted as per $term_template */
         'template' => __( '%s: %l.' ),
+        /* translators: %1$s: term link, %2$s: term name */
+        'term_template' => '<a href="%1$s">%2$s</a>',
     ) );
 
@@ -4195 +4203 @@
             $t['template'] = $args['template'];
         }
+        if ( empty( $t['term_template'] ) ) {
+            $t['term_template'] = $args['term_template'];
+        }
 
         $terms = get_object_term_cache( $post->ID, $taxonomy );
@@ -4203 +4214 @@
 
         foreach ( $terms as $term ) {
-            $links[] = "<a href='" . esc_attr( get_term_link( $term ) ) . "'>$term->name</a>";
+            $links[] = wp_sprintf( $t['term_template'], esc_attr( get_term_link( $term ) ), $term->name );
         }
         if ( $links ) {

trunk/tests/phpunit/tests/taxonomy.php

@@ -50 +50 @@
     }
 
+    /**
+     * @group 27238
+     */
+    public function test_get_the_taxonomies_term_template() {
+        $post_id = $this->factory->post->create();
+
+        $taxes = get_the_taxonomies( $post_id, array( 'term_template' => '%2$s' ) );
+        $this->assertEquals( 'Categories: Uncategorized.', $taxes['category'] );
+
+        $taxes = get_the_taxonomies( $post_id, array( 'term_template' => '<span class="foo"><a href="%1$s">%2$s</a></span>' ) );
+        $link = get_category_link( 1 );
+        $this->assertEquals( 'Categories: <span class="foo"><a href="' . $link . '">Uncategorized</a></span>.', $taxes['category'] );
+    }
+
     function test_the_taxonomies() {
         $post_id = $this->factory->post->create();
@@ -58 +72 @@
 
         $link = get_category_link( 1 );
-        $expected = "Categories: <a href='$link'>Uncategorized</a>.";
+        $expected = 'Categories: <a href="' . $link . '">Uncategorized</a>.';
         $this->assertEquals( $expected, $output );
+    }
+
+    /**
+     * @group 27238
+     */
+    function test_the_taxonomies_term_template() {
+        $post_id = $this->factory->post->create();
+
+        $output = get_echo( 'the_taxonomies', array( array( 'post' => $post_id, 'term_template' => '%2$s' ) ) );
+        $this->assertEquals( 'Categories: Uncategorized.', $output );
+
+        $output = get_echo( 'the_taxonomies', array( array( 'post' => $post_id, 'term_template' => '<span class="foo"><a href="%1$s">%2$s</a></span>' ) ) );
+        $link = get_category_link( 1 );
+        $this->assertEquals( 'Categories: <span class="foo"><a href="' . $link . '">Uncategorized</a></span>.', $output );
     }