Changeset 35515

Timestamp:

11/04/2015 09:23:28 PM (8 years ago)

Author:

boonebgorges

Message:

Don't allow term meta to be added to shared taxonomy terms.

add_term_meta() and update_term_meta() identify terms by $term_id. In
cases where a term is shared between taxonomies, $term_id is insufficient to
distinguish where the metadata belongs.

When attempting to add/update termmeta on a shared term, a WP_Error object
is returned. This gives developers enough information to decide whether they'd
like to force the term to be split and retry the save, or show an error in the
UI, or whatever.

Props boonebgorges, mboynes, DH-Shredder, jorbin, aaroncampbell.
Fixes #34544.

Location:

trunk

Files:

• src/wp-includes/taxonomy-functions.php (modified) (6 diffs)
• tests/phpunit/tests/term/meta.php (modified) (1 diff)

trunk/src/wp-includes/taxonomy-functions.php

@@ -1579 +1579 @@
  * @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 ) {
@@ -1585 +1586 @@
     if ( get_option( 'db_version' ) < 34370 ) {
         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 );
     }
 
@@ -1656 +1661 @@
  * @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 = '' ) {
@@ -1662 +1668 @@
     if ( get_option( 'db_version' ) < 34370 ) {
         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 );
     }
 
@@ -4008 +4018 @@
     }
 
+    // If we've just split the final shared term, 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.
@@ -4253 +4275 @@
 
     return $term_id;
+}
+
+/**
+ * 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;
 }
 

trunk/tests/phpunit/tests/term/meta.php

@@ -308 +308 @@
     }
 
+    /**
+     * @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 );