Changeset 43049

Timestamp:

04/30/2018 09:07:16 PM (6 years ago)

Author:

boonebgorges

Message:

Taxonomy: Ensure that invalid term objects are discarded in WP_Term_Query.

The get_term() mapping may result in term objects that are null or
WP_Error when plugins use get_term or a related filter. Since null
and error objects are not valid results for a term query, we discard
them.

Props GM_Alex.
See #42691.

Location:

trunk

Files:

• src/wp-includes/class-wp-term-query.php (modified) (3 diffs)
• tests/phpunit/tests/term/query.php (modified) (1 diff)

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

@@ -679 +679 @@
         if ( false !== $cache ) {
             if ( 'all' === $_fields ) {
-                $cache = array_map( 'get_term', $cache );
+                $cache = $this->populate_terms( $cache );
             }
 
@@ -811 +811 @@
 
         if ( 'all' === $_fields || 'all_with_object_id' === $_fields ) {
-            $terms = array_map( 'get_term', $terms );
+            $terms = $this->populate_terms( $terms );
         }
 
@@ -973 +973 @@
         return $wpdb->prepare( '((t.name LIKE %s) OR (t.slug LIKE %s))', $like, $like );
     }
+
+    /**
+     * Creates an array of term objects from an array of term IDs.
+     *
+     * Also discards invalid term objects.
+     *
+     * @since 5.0.0
+     *
+     * @param array $term_ids Term IDs.
+     * @return array
+     */
+    protected function populate_terms( $term_ids ) {
+        $terms = array();
+
+        if ( ! is_array( $term_ids ) ) {
+            return $terms;
+        }
+
+        foreach ( $term_ids as $key => $term_id ) {
+            $term = get_term( $term_id );
+            if ( $term instanceof WP_Term ) {
+                $terms[ $key ] = $term;
+            }
+        }
+
+        return $terms;
+    }
 }

trunk/tests/phpunit/tests/term/query.php

@@ -615 +615 @@
         $this->assertSame( array(), $q->terms );
     }
+
+    /**
+     * @ticket 42691
+     */
+    public function test_null_term_object_should_be_discarded() {
+        register_taxonomy( 'wptests_tax', 'post' );
+
+        $terms = self::factory()->term->create_many( 3, array(
+            'taxonomy' => 'wptests_tax',
+        ) );
+
+        $this->term_id = $terms[1];
+
+        add_filter( 'get_term', array( $this, 'filter_term_to_null' ) );
+        $found = get_terms( array(
+            'taxonomy'   => 'wptests_tax',
+            'hide_empty' => false,
+        ) );
+        remove_filter( 'get_term', array( $this, 'filter_term_to_null' ) );
+
+        $expected = array( $terms[0], $terms[2] );
+
+        $this->assertEqualSets( $expected, wp_list_pluck( $found, 'term_id' ) );
+    }
+
+    public function filter_term_to_null( $term ) {
+        if ( $this->term_id === $term->term_id ) {
+            return null;
+        }
+
+        return $term;
+    }
+
+    /**
+     * @ticket 42691
+     */
+    public function test_error_term_object_should_be_discarded() {
+        register_taxonomy( 'wptests_tax', 'post' );
+
+        $terms = self::factory()->term->create_many( 3, array(
+            'taxonomy' => 'wptests_tax',
+        ) );
+
+        $this->term_id = $terms[1];
+
+        add_filter( 'get_term', array( $this, 'filter_term_to_wp_error' ) );
+        $found = get_terms( array(
+            'taxonomy'   => 'wptests_tax',
+            'hide_empty' => false,
+        ) );
+        remove_filter( 'get_term', array( $this, 'filter_term_to_wp_error' ) );
+
+        $expected = array( $terms[0], $terms[2] );
+
+        $this->assertEqualSets( $expected, wp_list_pluck( $found, 'term_id' ) );
+    }
+
+    public function filter_term_to_wp_error( $term ) {
+        if ( $this->term_id === $term->term_id ) {
+            return new WP_Error( 'foo' );
+        }
+
+        return $term;
+    }
 }