Changeset 40275

Timestamp:

03/11/2017 02:26:11 AM (8 years ago)

Author:

boonebgorges

Message:

Don't run 'get_terms' filter when querying for terms within get_term_by().

Historically, it has been possible to call get_term_by() within
a 'get_terms' filter callback. Since get_term_by() was refactored
to use get_terms() internally [38677], callbacks of this nature
have resulted in infinite loops.

As a workaround, we introduce a 'suppress_filter' option to get_terms(),
and use it when calling the function from within get_term_by().

Props ocean90.
See #21760.

Location:

trunk

Files:

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

trunk/src/wp-includes/taxonomy.php

@@ -850 +850 @@
         'update_term_meta_cache' => false,
         'orderby'                => 'none',
+        'suppress_filter'        => true,
     );
 
@@ -1013 +1014 @@
  * @since 4.5.0 Changed the function signature so that the `$args` array can be provided as the first parameter.
  *              Introduced 'meta_key' and 'meta_value' parameters. Introduced the ability to order results by metadata.
+ * @since 4.8.0 Introduced 'suppress_filter' parameter.
  *
  * @internal The `$deprecated` parameter is parsed for backward compatibility only.
@@ -1084 +1086 @@
  *                                                Default empty.
  *     @type string       $meta_compare           Comparison operator to test the 'meta_value'. Default empty.
+ *     @type bool         $suppress_filter        Whether to suppress the {@see 'get_terms'} filter. Default false.
  * }
  * @param array $deprecated Argument array, when using the legacy function parameter format. If present, this
@@ -1095 +1098 @@
 
     $term_query = new WP_Term_Query();
+
+    $defaults = array(
+        'suppress_filter' => false,
+    );
 
     /*
@@ -1109 +1116 @@
     if ( $do_legacy_args ) {
         $taxonomies = (array) $args;
-        $args = wp_parse_args( $deprecated );
+        $args = wp_parse_args( $deprecated, $defaults );
         $args['taxonomy'] = $taxonomies;
     } else {
-        $args = wp_parse_args( $args );
+        $args = wp_parse_args( $args, $defaults );
         if ( isset( $args['taxonomy'] ) && null !== $args['taxonomy'] ) {
             $args['taxonomy'] = (array) $args['taxonomy'];
@@ -1126 +1133 @@
     }
 
+    // Don't pass suppress_filter to WP_Term_Query.
+    $suppress_filter = $args['suppress_filter'];
+    unset( $args['suppress_filter'] );
+
     $terms = $term_query->query( $args );
 
     // Count queries are not filtered, for legacy reasons.
     if ( ! is_array( $terms ) ) {
+        return $terms;
+    }
+
+    if ( $suppress_filter ) {
         return $terms;
     }

trunk/tests/phpunit/tests/term/getTermBy.php

@@ -193 +193 @@
         $this->assertContains( 'LIMIT 1', $wpdb->last_query );
     }
+
+    /**
+     * @ticket 21760
+     */
+    public function test_prevent_recursion_by_get_terms_filter() {
+        $action = new MockAction();
+
+        add_filter( 'get_terms', array( $action, 'filter' ) );
+        get_term_by( 'name', 'burrito', 'post_tag' );
+        remove_filter( 'get_terms', array( $action, 'filter' ) );
+
+        $this->assertEquals( 0, $action->get_call_count() );
+    }
 }