Changeset 34538

Timestamp:

09/25/2015 01:46:36 PM (11 years ago)

Author:

boonebgorges

Message:

Bust term query cache when modifying term meta.

The 'last_changed' incrementor is used to invalidate the get_terms() query
cache. Since get_terms() queries may reference 'meta_query', changing term
metadata could change the results of the queries. So we invalidate the cache
on add, delete, and update.

See #10142.

Location:

trunk

Files:

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

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

@@ -1489 +1489 @@
  */
 function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {
-        return add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique );
+        $added = add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique );
+
+        // Bust term query cache.
+        if ( $added ) {
+                wp_cache_set( 'last_changed', microtime(), 'terms' );
+        }
+
+        return $added;
 }
 
@@ -1503 +1510 @@
  */
 function delete_term_meta( $term_id, $meta_key, $meta_value = '' ) {
-        return delete_metadata( 'term', $term_id, $meta_key, $meta_value );
+        $deleted = delete_metadata( 'term', $term_id, $meta_key, $meta_value );
+
+        // Bust term query cache.
+        if ( $deleted ) {
+                wp_cache_set( 'last_changed', microtime(), 'terms' );
+        }
+
+        return $deleted;
 }
 
@@ -1537 +1551 @@
  */
 function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) {
-        return update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value );
+        $updated = update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value );
+
+        // Bust term query cache.
+        if ( $updated ) {
+                wp_cache_set( 'last_changed', microtime(), 'terms' );
+        }
+
+        return $updated;
 }
 

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

@@ -145 +145 @@
                 }
         }
+
+        public function test_adding_term_meta_should_bust_get_terms_cache() {
+                $terms = $this->factory->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
+
+                add_term_meta( $terms[0], 'foo', 'bar' );
+
+                // Prime cache.
+                $found = get_terms( 'wptests_tax', array(
+                        'hide_empty' => false,
+                        'fields' => 'ids',
+                        'meta_query' => array(
+                                array(
+                                        'key' => 'foo',
+                                        'value' => 'bar',
+                                ),
+                        ),
+                ) );
+
+                $this->assertEqualSets( array( $terms[0] ), $found );
+
+                add_term_meta( $terms[1], 'foo', 'bar' );
+
+                $found = get_terms( 'wptests_tax', array(
+                        'hide_empty' => false,
+                        'fields' => 'ids',
+                        'meta_query' => array(
+                                array(
+                                        'key' => 'foo',
+                                        'value' => 'bar',
+                                ),
+                        ),
+                ) );
+
+                $this->assertEqualSets( array( $terms[0], $terms[1] ), $found );
+        }
+
+        public function test_updating_term_meta_should_bust_get_terms_cache() {
+                $terms = $this->factory->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
+
+                add_term_meta( $terms[0], 'foo', 'bar' );
+                add_term_meta( $terms[1], 'foo', 'baz' );
+
+                // Prime cache.
+                $found = get_terms( 'wptests_tax', array(
+                        'hide_empty' => false,
+                        'fields' => 'ids',
+                        'meta_query' => array(
+                                array(
+                                        'key' => 'foo',
+                                        'value' => 'bar',
+                                ),
+                        ),
+                ) );
+
+                $this->assertEqualSets( array( $terms[0] ), $found );
+
+                update_term_meta( $terms[1], 'foo', 'bar' );
+
+                $found = get_terms( 'wptests_tax', array(
+                        'hide_empty' => false,
+                        'fields' => 'ids',
+                        'meta_query' => array(
+                                array(
+                                        'key' => 'foo',
+                                        'value' => 'bar',
+                                ),
+                        ),
+                ) );
+
+                $this->assertEqualSets( array( $terms[0], $terms[1] ), $found );
+        }
+
+        public function test_deleting_term_meta_should_bust_get_terms_cache() {
+                $terms = $this->factory->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
+
+                add_term_meta( $terms[0], 'foo', 'bar' );
+                add_term_meta( $terms[1], 'foo', 'bar' );
+
+                // Prime cache.
+                $found = get_terms( 'wptests_tax', array(
+                        'hide_empty' => false,
+                        'fields' => 'ids',
+                        'meta_query' => array(
+                                array(
+                                        'key' => 'foo',
+                                        'value' => 'bar',
+                                ),
+                        ),
+                ) );
+
+                $this->assertEqualSets( array( $terms[0], $terms[1] ), $found );
+
+                delete_term_meta( $terms[1], 'foo', 'bar' );
+
+                $found = get_terms( 'wptests_tax', array(
+                        'hide_empty' => false,
+                        'fields' => 'ids',
+                        'meta_query' => array(
+                                array(
+                                        'key' => 'foo',
+                                        'value' => 'bar',
+                                ),
+                        ),
+                ) );
+
+                $this->assertEqualSets( array( $terms[0] ), $found );
+        }
 }