Ticket #9547: 9547.3.diff

src/wp-includes/category-template.php

@@ -1238 +1238 @@
  *
  * @since 2.5.0
  *
+ * @see wp_get_object_terms() for reference on the $args param
+ *
  * @param int|object $post Post ID or object.
  * @param string $taxonomy Taxonomy name.
+ * @param array $args Accepts the same arguments as the $args param for wp_get_object_terms.
  * @return array|bool|WP_Error Array of term objects on success, false or WP_Error on failure.
  */
-function get_the_terms( $post, $taxonomy ) {
+function get_the_terms( $post, $taxonomy, $args = array() ) {
         if ( ! $post = get_post( $post ) )
                 return false;
 
-        $terms = get_object_term_cache( $post->ID, $taxonomy );
+        $key = "{$post->ID}:$taxonomy:" . md5( serialize( $args ) );
+        $group = "{$taxonomy}_relationships";
+        $terms = wp_cache_get( $key, $group );
+
         if ( false === $terms ) {
-                $terms = wp_get_object_terms( $post->ID, $taxonomy );
-                wp_cache_add($post->ID, $terms, $taxonomy . '_relationships');
+                $terms = wp_get_object_terms( $post->ID, $taxonomy, $args );
+                wp_cache_add( $key, $terms, $group );
         }
 
         /**
@@ -1274 +1280 @@
  *
  * @since 2.5.0
  *
+ * @see wp_get_object_terms() for reference on the $args param
+ *
  * @param int $id Post ID.
  * @param string $taxonomy Taxonomy name.
  * @param string $before Optional. Before list.
  * @param string $sep Optional. Separate items using this.
  * @param string $after Optional. After list.
+ * @param array $args Accepts the same arguments as the $args param for wp_get_object_terms.
  * @return string|bool|WP_Error A list of terms on success, false or WP_Error on failure.
  */
-function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
-        $terms = get_the_terms( $id, $taxonomy );
+function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '', $args = array() ) {
+        $terms = get_the_terms( $id, $taxonomy, $args );
 
         if ( is_wp_error( $terms ) )
                 return $terms;
@@ -1322 +1331 @@
  * @param string $before Optional. Before list.
  * @param string $sep Optional. Separate items using this.
  * @param string $after Optional. After list.
+ * @param array $args Accepts the same arguments as the $args param for wp_get_object_terms.
  * @return null|bool False on WordPress error. Returns null when displaying.
  */
-function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
-        $term_list = get_the_term_list( $id, $taxonomy, $before, $sep, $after );
+function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '', $args = array() ) {
+        $term_list = get_the_term_list( $id, $taxonomy, $before, $sep, $after, $args );
 
         if ( is_wp_error( $term_list ) )
                 return false;

tests/phpunit/tests/term.php

@@ -69 +69 @@
                 $this->assertNull( term_exists(rand_str()) );
                 $this->assertEquals( 0, term_exists(0) );
                 $this->assertEquals( 0, term_exists('') );
-                $this->assertEquals( 0, term_exists(NULL) );
+                $this->assertEquals( 0, term_exists(null) );
         }
 
         /**
@@ -220 +220 @@
 
                 // get_the_terms() does prime the cache.
                 $terms = get_the_terms( $post_id, $this->taxonomy );
-                $cache = wp_cache_get( $post_id, $this->taxonomy . '_relationships');
-                $this->assertInternalType( 'array', $cache );
+                $cache1 = wp_cache_get( $post_id . ':' . $this->taxonomy . ':' . md5( serialize( array() ) ), $this->taxonomy . '_relationships');
+                $this->assertInternalType( 'array', $cache1 );
 
+                // get_the_terms() does prime the cache differently when the args parameter has a value.
+                $terms = get_the_terms( $post_id, $this->taxonomy, array( 'order' => 'DESC' ) );
+                $cache2 = wp_cache_get( $post_id . ':' . $this->taxonomy . ':' . md5( serialize( array( 'order' => 'DESC' ) ) ), $this->taxonomy . '_relationships');
+                $this->assertInternalType( 'array', $cache2 );
+
+                // Verify that the two cache gets returned different results
+                $this->assertNotEquals( $cache1, $cache2 );
+
                 // Cache should be empty after a set.
                 $tt_2 = wp_set_object_terms( $post_id, $terms_2, $this->taxonomy );
                 $this->assertEquals( 2, count($tt_2) );
@@ -590 +598 @@
                 $this->assertCount( 3, $terms2 );
                 $this->assertEquals( array( $cat_id, $cat_id, $cat_id2 ), wp_list_pluck( $terms2, 'term_id' ) );
         }
+
+        function test_get_the_terms_by_order() {
+                // Set up a sortable taxonomy. The only way to add a value to the term_order column is via a sortable tax.
+                register_taxonomy( 'sortable-taxonomy', 'post', array(
+                        'sort' => true,
+                ) );
+
+                $post_id = $this->factory->post->create();
+
+                // Create three tags to test ordering. Purposefully creating tags out of order to be able to easily verify ordering
+                $term1_id = $this->factory->term->create( array( 'taxonomy' => 'sortable-taxonomy', 'name' => 'M Term' ) );
+                $term2_id = $this->factory->term->create( array( 'taxonomy' => 'sortable-taxonomy', 'name' => 'A Term' ) );
+                $term3_id = $this->factory->term->create( array( 'taxonomy' => 'sortable-taxonomy', 'name' => 'Z Term' ) );
+
+                // Attach the terms to the post
+                $tt_ids = wp_set_object_terms(
+                        $post_id,
+                        array( $term1_id, $term2_id, $term3_id ),
+                        'sortable-taxonomy'
+                );
+
+                // Verify get by term order
+                $post_terms_by_term_order = wp_get_post_terms( $post_id, 'sortable-taxonomy', array( 'orderby' => 'term_order' ) );
+                $this->assertEquals( array( $term1_id, $term2_id, $term3_id ), wp_list_pluck( $post_terms_by_term_order, 'term_id' ) );
+
+                // Verify get by term slug
+                $post_terms_by_term_slug = wp_get_post_terms( $post_id, 'sortable-taxonomy', array( 'orderby' => 'slug' ) );
+                $this->assertEquals( array( $term2_id, $term1_id, $term3_id ), wp_list_pluck( $post_terms_by_term_slug, 'term_id' ) );
+
+                // Verify get by term name
+                $post_terms_by_term_name = wp_get_post_terms( $post_id, 'sortable-taxonomy', array( 'orderby' => 'name' ) );
+                $this->assertEquals( array( $term2_id, $term1_id, $term3_id ), wp_list_pluck( $post_terms_by_term_name, 'term_id' ) );
+        }
+
+        /**
+         * @ticket 9547
+         */
+        function test_get_the_terms_with_args() {
+                $post_id = $this->factory->post->create();
+
+                // Create three tags to test ordering. Purposefully creating tags out of order to be able to easily verify ordering
+                $term1_id = $this->factory->term->create( array( 'taxonomy' => 'post_tag', 'name' => 'M Tag', ) );
+                $term2_id = $this->factory->term->create( array( 'taxonomy' => 'post_tag', 'name' => 'A Tag', ) );
+                $term3_id = $this->factory->term->create( array( 'taxonomy' => 'post_tag', 'name' => 'Z Tag', ) );
+
+                // Attach the terms to the post
+                $tt_ids = wp_set_object_terms(
+                        $post_id,
+                        array( $term1_id, $term2_id, $term3_id ),
+                        'post_tag'
+                );
+
+                // Make sure that the terms added are available when the args parameter is used
+                $terms = get_the_terms( $post_id, 'post_tag', array( 'orderby' => 'name' ) );
+                $this->assertEquals( array( $term2_id, $term1_id, $term3_id ), wp_list_pluck( $terms, 'term_id' ) );
+
+                /**
+                 * Verify that using the args parameter produces two different results when the args parameter is different. This
+                 * suggests that the cache key is working correctly by taking the args into account.
+                 */
+                $orderby_asc  = get_the_terms( $post_id, 'post_tag', array( 'order' => 'ASC' ) );
+                $orderby_desc = get_the_terms( $post_id, 'post_tag', array( 'order' => 'DESC' ) );
+                $this->assertFalse( in_array( $orderby_asc, $orderby_desc ) );
+        }
+
+        /**
+         * @ticket 9547
+         */
+        function test_get_the_term_list_with_args() {
+                $post_id = $this->factory->post->create();
+
+                // Create three tags to test ordering. Purposefully creating tags out of order to be able to easily verify ordering
+                $term1_id = $this->factory->term->create( array( 'taxonomy' => 'post_tag', 'name' => 'M Tag', ) );
+                $term2_id = $this->factory->term->create( array( 'taxonomy' => 'post_tag', 'name' => 'A Tag', ) );
+                $term3_id = $this->factory->term->create( array( 'taxonomy' => 'post_tag', 'name' => 'Z Tag', ) );
+
+                // Attach the terms to the post
+                $tt_ids = wp_set_object_terms(
+                        $post_id,
+                        array( $term1_id, $term2_id, $term3_id ),
+                        'post_tag'
+                );
+
+                // Verify that the term list returns its expected result
+                $links = array();
+                foreach ( array( $term2_id, $term1_id, $term3_id ) as $term_id ) {
+                        $term      = get_term( $term_id, 'post_tag' );
+                        $term_link = get_term_link( $term_id, 'post_tag' );
+                        $links[]   = '<a href="' . esc_url( $term_link ) . '" rel="tag">' . $term->name . '</a>';
+                }
+                $expected = join( '', $links );
+
+                $this->assertEquals( $expected, get_the_term_list( $post_id, 'post_tag', '', '', '', array( 'order' => 'ASC', 'orderby' => 'name' ) ) );
+
+                /**
+                 * Verify that using the args parameter produces two different results when the args parameter is different. This
+                 * suggests that the cache key is working correctly by taking the args into account.
+                 */
+                $orderby_asc  = get_the_term_list( $post_id, 'post_tag', '', '', '', array( 'order' => 'ASC' ) );
+                $orderby_desc = get_the_term_list( $post_id, 'post_tag', '', '', '', array( 'order' => 'DESC' ) );
+                $this->assertNotEquals( $orderby_asc, $orderby_desc );
+        }
+
+        /**
+         * @ticket 9547
+         */
+        function test_the_terms_with_args() {
+                $post_id = $this->factory->post->create();
+
+                // Create three tags to test ordering. Purposefully creating tags out of order to be able to easily verify ordering
+                $term1_id = $this->factory->term->create( array( 'taxonomy' => 'post_tag', 'name' => 'M Tag', ) );
+                $term2_id = $this->factory->term->create( array( 'taxonomy' => 'post_tag', 'name' => 'A Tag', ) );
+                $term3_id = $this->factory->term->create( array( 'taxonomy' => 'post_tag', 'name' => 'Z Tag', ) );
+
+                // Attach the terms to the post
+                $tt_ids = wp_set_object_terms(
+                        $post_id,
+                        array( $term1_id, $term2_id, $term3_id ),
+                        'post_tag'
+                );
+
+                // Prepare a string that represents the output of the_terms when setting orderby to name and order to ASC
+                $links = array();
+                foreach ( array( $term2_id, $term1_id, $term3_id ) as $term_id ) {
+                        $term      = get_term( $term_id, 'post_tag' );
+                        $term_link = get_term_link( $term_id, 'post_tag' );
+                        $links[] = '<a href="' . esc_url( $term_link ) . '" rel="tag">' . $term->name . '</a>';
+                }
+                $expected1 = join( ', ', $links );
+
+                /**
+                 * Prepare a string that represents the output of the_terms when setting order to DESC; It is important to test
+                 * two variants to ensure that the cache keys are working properly.
+                 */
+                $links = array();
+                foreach ( array( $term3_id, $term1_id, $term2_id ) as $term_id ) {
+                        $term      = get_term( $term_id, 'post_tag' );
+                        $term_link = get_term_link( $term_id, 'post_tag' );
+                        $links[] = '<a href="' . esc_url( $term_link ) . '" rel="tag">' . $term->name . '</a>';
+                }
+                $expected2 = join( ', ', $links );
+
+                /**
+                 * At the end of the test, the_terms will run twice producing output. The output should be the concatenation of
+                 * the first and second test string.
+                 */
+                $this->expectOutputString( $expected1 . $expected2 );
+
+                the_terms( $post_id, 'post_tag', '', ', ', '', array( 'order' => 'ASC', 'orderby' => 'name' ) );
+                the_terms( $post_id, 'post_tag', '', ', ', '', array( 'order' => 'DESC' ) );
+        }
 }