Changeset 35032

Timestamp:

10/12/2015 03:12:29 PM (9 years ago)

Author:

boonebgorges

Message:

Don't cache WP_Term objects in wp_get_object_cache().

The data stored in the cache should be raw database query results, not
WP_Term objects (which may be modified by plugins, and may contain additional
properties that shouldn't be cached).

If term relationships caches were handled in wp_get_object_terms() - where
a database query takes place - it would be straightforward to cache raw data.
See #34239. Since, in fact, get_the_terms() caches the value it gets from
wp_get_object_terms(), we need a technique that allows us to get raw data
from a WP_Term object. Mirroring WP_User, we introduce a data property
on term objects, which get_the_terms() uses to fetch cacheable term info.

Fixes #34262.

Location:

trunk

Files:

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

trunk/src/wp-includes/category-template.php

@@ -1138 +1138 @@
     if ( false === $terms ) {
         $terms = wp_get_object_terms( $post->ID, $taxonomy );
-        wp_cache_add($post->ID, $terms, $taxonomy . '_relationships');
-    }
+        $to_cache = array();
+        foreach ( $terms as $key => $term ) {
+            $to_cache[ $key ] = $term->data;
+        }
+        wp_cache_add( $post->ID, $to_cache, $taxonomy . '_relationships' );
+    }
+
+    $terms = array_map( 'get_term', $terms );
 
     /**

trunk/src/wp-includes/class-wp-term.php

@@ -97 +97 @@
 
     /**
+     * Info about the term, as stored in the database.
+     *
+     * @since 4.4.0
+     * @access protected
+     * @var array
+     */
+    protected $data = array();
+
+    /**
      * Stores the term object's sanitization level.
      *
@@ -158 +167 @@
             $this->$key = $value;
         }
+
+        $this->data = sanitize_term( $term, $this->taxonomy, $this->filter );
     }
 
@@ -183 +194 @@
         return get_object_vars( $this );
     }
+
+    /**
+     * Getter.
+     *
+     * @since 4.4.0
+     * @access public
+     *
+     * @return mixed
+     */
+    public function __get( $key ) {
+        switch ( $key ) {
+            case 'data' :
+                return sanitize_term( $this->{$key}, $this->data->taxonomy, 'raw' );
+                break;
+        }
+    }
 }

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

@@ -3063 +3063 @@
 
     // First, get all of the original args
-    $term = get_term( $term_id, $taxonomy, ARRAY_A );
+    $term = get_term( $term_id, $taxonomy );
 
     if ( is_wp_error( $term ) ) {
@@ -3073 +3073 @@
     }
 
+    $term = (array) $term->data;
+
     // Escape data pulled from DB.
-    $term = wp_slash($term);
+    $term = wp_slash( $term );
 
     // Merge old and new args with new args overwriting old ones.

trunk/tests/phpunit/tests/term.php

@@ -539 +539 @@
 
     /**
+     * @ticket 34262
+     */
+    public function test_get_the_terms_should_not_cache_wp_term_objects() {
+        $p = $this->factory->post->create();
+        register_taxonomy( 'wptests_tax', 'post' );
+        $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+        wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+        // Prime the cache.
+        $terms = get_the_terms( $p, 'wptests_tax' );
+
+        $cached = get_object_term_cache( $p, 'wptests_tax' );
+
+        $this->assertNotEmpty( $cached );
+        $this->assertSame( $t, (int) $cached[0]->term_id );
+        $this->assertNotInstanceOf( 'WP_Term', $cached[0] );
+    }
+
+    /**
+     * @ticket 34262
+     */
+    public function test_get_the_terms_should_return_wp_term_objects_from_cache() {
+        $p = $this->factory->post->create();
+        register_taxonomy( 'wptests_tax', 'post' );
+        $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+        wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+        // Prime the cache.
+        get_the_terms( $p, 'wptests_tax' );
+
+        $cached = get_the_terms( $p, 'wptests_tax' );
+
+        $this->assertNotEmpty( $cached );
+        $this->assertSame( $t, (int) $cached[0]->term_id );
+        $this->assertInstanceOf( 'WP_Term', $cached[0] );
+    }
+
+    /**
      * @ticket 31086
      */