Changeset 35537 for trunk/tests/phpunit/tests/term/getTerm.php

Timestamp:

11/05/2015 04:44:59 PM (9 years ago)

Author:

boonebgorges

Message:

Make get_term() behave more consistently in the context of shared terms.

When WP_Term was introduced in [34997], the $taxonomy parameter for
get_term() was made optional. This meant that, when the optional param was
omitted, get_term() had no way of determining which term was intended when
the term_id was shared between multiple taxonomies. As a (somewhat sneaky) way
of fixing things, get_term() split any shared terms it found. But this could
cause problems with developer expectations: it's not clear why requesting a
term should result in a database update, much less a potential change in the
ID of a term.

In place of this technique, this changeset introduces a number of changes that
make the handling of shared terms a bit less insane:

• When a taxonomy is provided to get_term(), and a cached term is found matching the term_id, make sure the taxonomy also matches before returning it.
• When a taxonomy is not provided, ensure that the term is not shared before adding it to the cache.
• When a term is shared between taxonomies and no taxonomy is provided, return a WP_Error rather than splitting the term.
• When a term is shared between taxonomies, only one of which is valid, return the term from that taxonomy.

Props boonebgorges, dlh.
Fixes #34533.

File:

• trunk/tests/phpunit/tests/term/getTerm.php (modified) (2 diffs)

trunk/tests/phpunit/tests/term/getTerm.php

@@ -10 +10 @@
     }
 
+    /**
+     * Utility function for generating two shared terms, in the 'wptests_tax' and 'wptests_tax_2' taxonomies.
+     *
+     * @return array Array of term_id/old_term_id/term_taxonomy_id triplets.
+     */
+    protected function generate_shared_terms() {
+        global $wpdb;
+
+        register_taxonomy( 'wptests_tax_2', 'post' );
+
+        $t1 = wp_insert_term( 'Foo', 'wptests_tax' );
+        $t2 = wp_insert_term( 'Foo', 'wptests_tax_2' );
+
+        // Manually modify because shared terms shouldn't naturally occur.
+        $wpdb->update( $wpdb->term_taxonomy,
+            array( 'term_id' => $t1['term_id'] ),
+            array( 'term_taxonomy_id' => $t2['term_taxonomy_id'] ),
+            array( '%d' ),
+            array( '%d' )
+        );
+
+        return array(
+            array(
+                'term_id' => $t1['term_id'],
+                'old_term_id' => $t1['term_id'],
+                'term_taxonomy_id' => $t1['term_taxonomy_id'],
+            ),
+            array(
+                'term_id' => $t1['term_id'],
+                'old_term_id' => $t2['term_id'],
+                'term_taxonomy_id' => $t2['term_taxonomy_id'],
+            ),
+        );
+    }
+
     public function test_should_return_error_for_empty_term() {
         $found = get_term( '', 'wptests_tax' );
@@ -115 +150 @@
         $this->assertNull( get_term( $term_id, 'category' ) );
     }
+
+    /**
+     * @ticket 34533
+     */
+    public function test_should_return_wp_error_when_term_is_shared_and_no_taxonomy_is_specified() {
+        $terms = $this->generate_shared_terms();
+
+        $found = get_term( $terms[0]['term_id'] );
+
+        $this->assertWPError( $found );
+    }
+
+    /**
+     * @ticket 34533
+     */
+    public function test_should_return_term_when_term_is_shared_and_correct_taxonomy_is_specified() {
+        $terms = $this->generate_shared_terms();
+
+        $found = get_term( $terms[0]['term_id'], 'wptests_tax' );
+
+        $this->assertInstanceOf( 'WP_Term', $found );
+        $this->assertSame( $terms[0]['term_id'], $found->term_id );
+    }
+
+    /**
+     * @ticket 34533
+     */
+    public function test_should_return_null_when_term_is_shared_and_incorrect_taxonomy_is_specified() {
+        $terms = $this->generate_shared_terms();
+
+        $found = get_term( $terms[0]['term_id'], 'post_tag' );
+
+        $this->assertNull( $found );
+    }
+
+    /**
+     * @ticket 34533
+     */
+    public function test_shared_term_in_cache_should_be_ignored_when_specifying_a_different_taxonomy() {
+        global $wpdb;
+
+        $terms = $this->generate_shared_terms();
+
+        // Prime cache for 'wptests_tax'.
+        get_term( $terms[0]['term_id'], 'wptests_tax' );
+        $num_queries = $wpdb->num_queries;
+
+        // Database should be hit again.
+        $found = get_term( $terms[1]['term_id'], 'wptests_tax_2' );
+        $num_queries++;
+
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+        $this->assertInstanceOf( 'WP_Term', $found );
+        $this->assertSame( 'wptests_tax_2', $found->taxonomy );
+    }
+
+    /**
+     * @ticket 34533
+     */
+    public function test_should_return_error_when_only_matching_term_is_in_an_invalid_taxonomy() {
+        $t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+
+        _unregister_taxonomy( 'wptests_tax' );
+
+        $found = get_term( $t );
+        $this->assertWPError( $found );
+        $this->assertSame( 'invalid_taxonomy', $found->get_error_code() );
+    }
+
+    /**
+     * @ticket 34533
+     */
+    public function test_term_should_be_returned_when_id_is_shared_only_with_invalid_taxonomies() {
+        $terms = $this->generate_shared_terms();
+
+        _unregister_taxonomy( 'wptests_tax' );
+
+        $found = get_term( $terms[1]['term_id'] );
+        $this->assertInstanceOf( 'WP_Term', $found );
+        $this->assertSame( 'wptests_tax_2', $found->taxonomy );
+        $this->assertSame( $terms[1]['term_id'], $found->term_id );
+    }
 }