Changeset 34999

Timestamp:

10/10/2015 03:38:41 AM (9 years ago)

Author:

boonebgorges

Message:

Return WP_Post objects from wp_get_object_terms().

A side effect of this change is that terms stored in the cache no longer have
an object_id associated with them. Previously, object_id had always been
cached when the term cache was populated via wp_get_object_terms(), a
strategy that was mostly harmless but still incorrect.

See #14162.

Location:

trunk

Files:

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

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

@@ -2195 +2195 @@
  * @since 4.2.0 Added support for 'taxonomy', 'parent', and 'term_taxonomy_id' values of `$orderby`.
  *              Introduced `$parent` argument.
- * @since 4.4.0 Introduced `$meta_query` and `$update_term_meta_cache` arguments.
+ * @since 4.4.0 Introduced `$meta_query` and `$update_term_meta_cache` arguments. When `$fields` is 'all' or
+ *              'all_with_object_id', an array of `WP_Term` objects will be returned.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -2337 +2338 @@
     if ( 'all' == $fields || 'all_with_object_id' == $fields ) {
         $_terms = $wpdb->get_results( $query );
+        $object_id_index = array();
         foreach ( $_terms as $key => $term ) {
-            $_terms[$key] = sanitize_term( $term, $taxonomy, 'raw' );
-        }
+            $term = sanitize_term( $term, $taxonomy, 'raw' );
+            $_terms[ $key ] = $term;
+
+            if ( isset( $term->object_id ) ) {
+                $object_id_index[ $key ] = $term->object_id;
+            }
+        }
+
+        update_term_cache( $_terms );
+        $_terms = array_map( 'get_term', $_terms );
+
+        // Re-add the object_id data, which is lost when fetching terms from cache.
+        if ( 'all_with_object_id' === $fields ) {
+            foreach ( $_terms as $key => $_term ) {
+                if ( isset( $object_id_index[ $key ] ) ) {
+                    $_term->object_id = $object_id_index[ $key ];
+                }
+            }
+        }
+
         $terms = array_merge( $terms, $_terms );
-        update_term_cache( $terms );
         $objects = true;
+
     } elseif ( 'ids' == $fields || 'names' == $fields || 'slugs' == $fields ) {
         $_terms = $wpdb->get_col( $query );
@@ -3556 +3576 @@
 function update_term_cache( $terms, $taxonomy = '' ) {
     foreach ( (array) $terms as $term ) {
-        $term_taxonomy = $taxonomy;
-        if ( empty($term_taxonomy) )
-            $term_taxonomy = $term->taxonomy;
-
-        wp_cache_add( $term->term_id, $term, 'terms' );
+        // Create a copy in case the array was passed by reference.
+        $_term = $term;
+
+        // Object ID should not be cached.
+        unset( $_term->object_id );
+
+        wp_cache_add( $term->term_id, $_term, 'terms' );
     }
 }

trunk/tests/phpunit/tests/term/wpGetObjectTerms.php

@@ -499 +499 @@
     }
 
+    /**
+     * @ticket 14162
+     */
+    public function test_should_return_wp_term_objects_for_fields_all() {
+        register_taxonomy( 'wptests_tax', 'post' );
+        $p = $this->factory->post->create();
+        $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+        wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+        $found = wp_get_object_terms( $p, 'wptests_tax', array(
+            'fields' => 'all',
+        ) );
+
+        $this->assertNotEmpty( $found );
+        foreach ( $found as $f ) {
+            $this->assertInstanceOf( 'WP_Term', $f );
+        }
+    }
+
+    /**
+     * @ticket 14162
+     */
+    public function test_should_return_wp_term_objects_for_fields_all_with_object_id() {
+        register_taxonomy( 'wptests_tax', 'post' );
+        $p = $this->factory->post->create();
+        $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+        wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+        $found = wp_get_object_terms( $p, 'wptests_tax', array(
+            'fields' => 'all_with_object_id',
+        ) );
+
+        $this->assertNotEmpty( $found );
+        foreach ( $found as $f ) {
+            $this->assertInstanceOf( 'WP_Term', $f );
+        }
+    }
+
+    /**
+     * @ticket 14162
+     */
+    public function test_should_prime_cache_for_found_terms() {
+        global $wpdb;
+
+        register_taxonomy( 'wptests_tax', 'post' );
+        $p = $this->factory->post->create();
+        $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+        wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+        $found = wp_get_object_terms( $p, 'wptests_tax', array(
+            'fields' => 'all_with_object_id',
+        ) );
+
+        $num_queries = $wpdb->num_queries;
+        $term = get_term( $t );
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
+
+    /**
+     * @ticket 14162
+     */
+    public function test_object_id_should_not_be_cached_with_term_object() {
+        register_taxonomy( 'wptests_tax', 'post' );
+        $p = $this->factory->post->create();
+        $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+        wp_set_object_terms( $p, $t, 'wptests_tax' );
+
+        $found = wp_get_object_terms( $p, 'wptests_tax', array(
+            'fields' => 'all_with_object_id',
+        ) );
+
+        foreach ( $found as $f ) {
+            $this->assertSame( $p, $f->object_id );
+        }
+
+        $term = get_term( $t );
+        $this->assertFalse( isset( $term->object_id ) );
+    }
+
+    /**
+     * @ticket 14162
+     */
+    public function test_term_cache_should_be_primed_for_all_taxonomies() {
+        global $wpdb;
+
+        register_taxonomy( 'wptests_tax1', 'post' );
+        register_taxonomy( 'wptests_tax2', 'post' );
+        $p = $this->factory->post->create();
+        $t1 = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax1' ) );
+        $t2 = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax2' ) );
+        wp_set_object_terms( $p, $t1, 'wptests_tax1' );
+        wp_set_object_terms( $p, $t2, 'wptests_tax2' );
+
+        $found = wp_get_object_terms( $p, array(
+            'wptests_tax1',
+            'wptests_tax2',
+        ), array(
+            'fields' => 'all_with_object_id',
+        ) );
+
+        $this->assertEqualSets( array( $t1, $t2 ), wp_list_pluck( $found, 'term_id' ) );
+
+        $num_queries = $wpdb->num_queries;
+        $term1 = get_term( $t1 );
+        $term2 = get_term( $t2 );
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
+
+    /**
+     * @ticket 14162
+     */
+    public function test_object_id_should_be_set_on_objects_that_share_terms() {
+        register_taxonomy( 'wptests_tax', 'post' );
+        $posts = $this->factory->post->create_many( 2 );
+        $t = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+        wp_set_object_terms( $posts[0], $t, 'wptests_tax' );
+        wp_set_object_terms( $posts[1], $t, 'wptests_tax' );
+
+        $found = wp_get_object_terms( $posts, 'wptests_tax', array(
+            'fields' => 'all_with_object_id',
+        ) );
+
+        $this->assertEqualSets( $posts, wp_list_pluck( $found, 'object_id' ) );
+    }
+
     public function filter_get_object_terms( $terms ) {
         $term_ids = wp_list_pluck( $terms, 'term_id' );