Ticket #34544: 34544.diff

src/wp-includes/taxonomy-functions.php

@@ -1556 +1556 @@
  * @param mixed  $meta_value Metadata value.
  * @param bool   $unique     Optional. Whether to bail if an entry with the same key is found for the term.
  *                           Default false.
- * @return int|bool Meta ID on success, false on failure.
+ * @return int|WP_Error|bool Meta ID on success. WP_Error when term_id is ambiguous between taxonomies.
+ *                           False on failure.
  */
 function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {
         // Bail if term meta table is not installed.
@@ -1564 +1565 @@
                 return false;
         }
 
+        if ( wp_term_is_shared( $term_id ) ) {
+                return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.'), $term_id );
+        }
+
         $added = add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique );
 
         // Bust term query cache.
@@ -1633 +1638 @@
  * @param string $meta_key   Metadata key.
  * @param mixed  $meta_value Metadata value.
  * @param mixed  $prev_value Optional. Previous value to check before removing.
- * @return int|bool Meta ID if the key didn't previously exist. True on successful update. False on failure.
+ * @return int|WP_Error|bool Meta ID if the key didn't previously exist. True on successful update.
+ *                           WP_Error when term_id is ambiguous between taxonomies. False on failure.
  */
 function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) {
         // Bail if term meta table is not installed.
@@ -1641 +1647 @@
                 return false;
         }
 
+        if ( wp_term_is_shared( $term_id ) ) {
+                return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.'), $term_id );
+        }
+
         $updated = update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value );
 
         // Bust term query cache.
@@ -3985 +3995 @@
                 update_option( '_split_terms', $split_term_data );
         }
 
+        // If we've just split the final shared terms, set the "finished" flag.
+        $shared_terms_exist = $wpdb->get_results(
+                "SELECT tt.term_id, t.*, count(*) as term_tt_count FROM {$wpdb->term_taxonomy} tt
+                 LEFT JOIN {$wpdb->terms} t ON t.term_id = tt.term_id
+                 GROUP BY t.term_id
+                 HAVING term_tt_count > 1
+                 LIMIT 1"
+        );
+        if ( ! $shared_terms_exist ) {
+                update_option( 'finished_splitting_shared_terms', true );
+        }
+
         /**
          * Fires after a previously shared taxonomy term is split into two separate terms.
          *
@@ -4233 +4255 @@
 }
 
 /**
+ * Determine whether a term is shared between multiple taxonomies.
+ *
+ * Shared taxonomy terms began to be split in 4.3, but failed cron tasks or other delays in upgrade routines may cause
+ * shared terms to remain.
+ *
+ * @since 4.4.0
+ *
+ * @param int $term_id
+ * @return bool
+ */
+function wp_term_is_shared( $term_id ) {
+        global $wpdb;
+
+        if ( get_option( 'finished_splitting_shared_terms' ) ) {
+                return false;
+        }
+
+        $tt_count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE term_id = %d", $term_id ) );
+
+        return $tt_count > 1;
+}
+
+/**
  * Generate a permalink for a taxonomy term archive.
  *
  * @since 2.5.0

tests/phpunit/tests/term/meta.php

@@ -307 +307 @@
                 $this->assertEqualSets( array( $terms[0] ), $found );
         }
 
+        /**
+         * @ticket 34544
+         */
+        public function test_add_term_meta_should_return_error_when_term_id_is_shared() {
+                global $wpdb;
+
+                update_option( 'finished_splitting_shared_terms', false );
+
+                register_taxonomy( 'wptests_tax', 'post' );
+                register_taxonomy( 'wptests_tax_2', 'post' );
+                register_taxonomy( 'wptests_tax_3', 'post' );
+
+                $t1 = wp_insert_term( 'Foo', 'wptests_tax' );
+                $t2 = wp_insert_term( 'Foo', 'wptests_tax_2' );
+                $t3 = wp_insert_term( 'Foo', 'wptests_tax_3' );
+
+                // 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' )
+                );
+
+                $wpdb->update( $wpdb->term_taxonomy,
+                        array( 'term_id' => $t1['term_id'] ),
+                        array( 'term_taxonomy_id' => $t3['term_taxonomy_id'] ),
+                        array( '%d' ),
+                        array( '%d' )
+                );
+
+                $found = add_term_meta( $t1['term_id'], 'bar', 'baz' );
+                $this->assertWPError( $found );
+                $this->assertSame( 'ambiguous_term_id', $found->get_error_code() );
+        }
+
+        /**
+         * @ticket 34544
+         */
+        public function test_update_term_meta_should_return_error_when_term_id_is_shared() {
+                global $wpdb;
+
+                update_option( 'finished_splitting_shared_terms', false );
+
+                register_taxonomy( 'wptests_tax', 'post' );
+                $t1 = wp_insert_term( 'Foo', 'wptests_tax' );
+                add_term_meta( $t1, 'foo', 'bar' );
+
+                register_taxonomy( 'wptests_tax_2', 'post' );
+                register_taxonomy( 'wptests_tax_3', 'post' );
+
+                $t2 = wp_insert_term( 'Foo', 'wptests_tax_2' );
+                $t3 = wp_insert_term( 'Foo', 'wptests_tax_3' );
+
+                // 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' )
+                );
+
+                $wpdb->update( $wpdb->term_taxonomy,
+                        array( 'term_id' => $t1['term_id'] ),
+                        array( 'term_taxonomy_id' => $t3['term_taxonomy_id'] ),
+                        array( '%d' ),
+                        array( '%d' )
+                );
+
+                $found = update_term_meta( $t1['term_id'], 'foo', 'baz' );
+                $this->assertWPError( $found );
+                $this->assertSame( 'ambiguous_term_id', $found->get_error_code() );
+        }
+
         public static function set_cache_results( $q ) {
                 $q->set( 'cache_results', true );
         }