Changeset 31418 for trunk/tests/phpunit/tests/term.php

Timestamp:

02/11/2015 07:41:54 PM (10 years ago)

Author:

boonebgorges

Message:

Split shared taxonomy terms on term update.

When updating an existing taxonomy term that shares its term_id with
another term, we generate a new row in wp_terms and associate the updated
term_taxonomy_id with the new term. This separates the terms, such that
updating the name of one term does not change the name of any others.

In cases where a plugin or theme stores term IDs in the database, term splitting
can cause backward compatibility issues. The current changeset introduces
two utilities to aid developers with the transition. The 'split_shared_term'
action fires when the split takes place, and should be used to catch changes in
term_id. In cases where 'split_shared_term' cannot be used, the
wp_get_split_term() function gives developers access to data about terms
that have previously been split. Documentation for these functions, with
examples, can be found in the Plugin Developer Handbook. WordPress itself
stores term IDs in this way in two places; _wp_check_split_default_terms()
and _wp_check_split_terms_in_menus() are hooked to 'split_shared_term' to
perform the necessary cleanup.

See [30241] for a previous attempt at the split. It was reverted in [30585]
for 4.1.0.

Props boonebgorges, mboynes.
See #5809.

File:

• trunk/tests/phpunit/tests/term.php (modified) (1 diff)

trunk/tests/phpunit/tests/term.php

@@ -761 +761 @@
     }
 
+    /**
+     * @ticket 5809
+     */
+    public function test_wp_update_term_should_split_shared_term() {
+        global $wpdb;
+
+        register_taxonomy( 'wptests_tax', 'post' );
+        register_taxonomy( 'wptests_tax_2', 'post' );
+
+        $t1 = wp_insert_term( 'Foo', 'wptests_tax' );
+        $t2 = wp_insert_term( 'Foo', 'wptests_tax_2' );
+
+        // Manually modify because split 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' )
+        );
+
+        $posts = $this->factory->post->create_many( 2 );
+        wp_set_object_terms( $posts[0], array( 'Foo' ), 'wptests_tax' );
+        wp_set_object_terms( $posts[1], array( 'Foo' ), 'wptests_tax_2' );
+
+        // Verify that the terms are shared.
+        $t1_terms = wp_get_object_terms( $posts[0], 'wptests_tax' );
+        $t2_terms = wp_get_object_terms( $posts[1], 'wptests_tax_2' );
+        $this->assertSame( $t1_terms[0]->term_id, $t2_terms[0]->term_id );
+
+        wp_update_term( $t2_terms[0]->term_id, 'wptests_tax_2', array(
+            'name' => 'New Foo',
+        ) );
+
+        $t1_terms = wp_get_object_terms( $posts[0], 'wptests_tax' );
+        $t2_terms = wp_get_object_terms( $posts[1], 'wptests_tax_2' );
+        $this->assertNotEquals( $t1_terms[0]->term_id, $t2_terms[0]->term_id );
+    }
+
+    /**
+     * @ticket 5809
+     */
+    public function test_wp_update_term_should_not_split_shared_term_before_410_schema_change() {
+        global $wpdb;
+
+        $db_version = get_option( 'db_version' );
+        update_option( 'db_version', 30055 );
+
+        register_taxonomy( 'wptests_tax', 'post' );
+        register_taxonomy( 'wptests_tax_2', 'post' );
+
+        $t1 = wp_insert_term( 'Foo', 'wptests_tax' );
+        $t2 = wp_insert_term( 'Foo', 'wptests_tax_2' );
+
+        // Manually modify because split 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' )
+        );
+
+        $posts = $this->factory->post->create_many( 2 );
+        wp_set_object_terms( $posts[0], array( 'Foo' ), 'wptests_tax' );
+        wp_set_object_terms( $posts[1], array( 'Foo' ), 'wptests_tax_2' );
+
+        // Verify that the term is shared.
+        $t1_terms = wp_get_object_terms( $posts[0], 'wptests_tax' );
+        $t2_terms = wp_get_object_terms( $posts[1], 'wptests_tax_2' );
+        $this->assertSame( $t1_terms[0]->term_id, $t2_terms[0]->term_id );
+
+        wp_update_term( $t2_terms[0]->term_id, 'wptests_tax_2', array(
+            'name' => 'New Foo',
+        ) );
+
+        // Term should still be shared.
+        $t1_terms = wp_get_object_terms( $posts[0], 'wptests_tax' );
+        $t2_terms = wp_get_object_terms( $posts[1], 'wptests_tax_2' );
+        $this->assertSame( $t1_terms[0]->term_id, $t2_terms[0]->term_id );
+
+        update_option( 'db_version', $db_version );
+    }
+
     public function test_wp_update_term_alias_of_no_term_group() {
         register_taxonomy( 'wptests_tax', 'post' );