Changeset 56585

Timestamp:

09/14/2023 12:38:04 PM (3 years ago)

Author:

spacedmonkey

Message:

Taxonomy: Introduce 'cache_results' parameter to WP_Term_Query for bypassing query caching.

Incorporating a new 'cache_results' parameter into the WP_Term_Query class, this commit empowers developers with the ability to bypass query caches, explicitly triggering database queries when needed. This brings the WP_Term_Query class inline with WP_Query and WP_User_Query that already have a 'cache_results' parameter.

Update the term_exists function to use this new parameter, so the term query caches are not used while importing.

Props dlh, spacedmonkey, peterwilsoncc.
Fixes #52710.

Location:

trunk

Files:

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

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

@@ -92 +92 @@
          * @since 5.1.0 Introduced the 'meta_compare_key' parameter.
          * @since 5.3.0 Introduced the 'meta_type_key' parameter.
+         * @since 6.4.0 Introduced the 'cache_results' parameter.
          *
          * @param string|array $query {
@@ -179 +180 @@
          *     @type string          $cache_domain           Unique cache key to be produced when this query is stored in
          *                                                   an object cache. Default 'core'.
+        *      @type bool            $cache_results          Whether to cache term information. Default true.
          *     @type bool            $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
          *     @type string|string[] $meta_key               Meta key or keys to filter by.
@@ -221 +223 @@
                         'childless'              => false,
                         'cache_domain'           => 'core',
+                        'cache_results'          => true,
                         'update_term_meta_cache' => true,
                         'meta_query'             => '',
@@ -777 +780 @@
                 }
 
-                $cache_key = $this->generate_cache_key( $args, $this->request );
-                $cache     = wp_cache_get( $cache_key, 'term-queries' );
-
-                if ( false !== $cache ) {
-                        if ( 'ids' === $_fields ) {
-                                $cache = array_map( 'intval', $cache );
-                        } elseif ( 'count' !== $_fields ) {
-                                if ( ( 'all_with_object_id' === $_fields && ! empty( $args['object_ids'] ) )
+                if ( $args['cache_results'] ) {
+                        $cache_key = $this->generate_cache_key( $args, $this->request );
+                        $cache     = wp_cache_get( $cache_key, 'term-queries' );
+
+                        if ( false !== $cache ) {
+                                if ( 'ids' === $_fields ) {
+                                        $cache = array_map( 'intval', $cache );
+                                } elseif ( 'count' !== $_fields ) {
+                                        if ( ( 'all_with_object_id' === $_fields && ! empty( $args['object_ids'] ) )
                                         || ( 'all' === $_fields && $args['pad_counts'] || $fields_is_filtered )
-                                ) {
-                                        $term_ids = wp_list_pluck( $cache, 'term_id' );
-                                } else {
-                                        $term_ids = array_map( 'intval', $cache );
+                                        ) {
+                                                $term_ids = wp_list_pluck( $cache, 'term_id' );
+                                        } else {
+                                                $term_ids = array_map( 'intval', $cache );
+                                        }
+
+                                        _prime_term_caches( $term_ids, $args['update_term_meta_cache'] );
+
+                                        $term_objects = $this->populate_terms( $cache );
+                                        $cache        = $this->format_terms( $term_objects, $_fields );
                                 }
 
-                                _prime_term_caches( $term_ids, $args['update_term_meta_cache'] );
-
-                                $term_objects = $this->populate_terms( $cache );
-                                $cache        = $this->format_terms( $term_objects, $_fields );
-                        }
-
-                        $this->terms = $cache;
-                        return $this->terms;
+                                $this->terms = $cache;
+                                return $this->terms;
+                        }
                 }
 
                 if ( 'count' === $_fields ) {
                         $count = $wpdb->get_var( $this->request ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-                        wp_cache_set( $cache_key, $count, 'term-queries' );
+                        if ( $args['cache_results'] ) {
+                                wp_cache_set( $cache_key, $count, 'term-queries' );
+                        }
                         return $count;
                 }
@@ -811 +818 @@
 
                 if ( empty( $terms ) ) {
-                        wp_cache_add( $cache_key, array(), 'term-queries' );
+                        if ( $args['cache_results'] ) {
+                                wp_cache_add( $cache_key, array(), 'term-queries' );
+                        }
                         return array();
                 }
@@ -893 +902 @@
                 }
 
-                wp_cache_add( $cache_key, $term_cache, 'term-queries' );
+                if ( $args['cache_results'] ) {
+                        wp_cache_add( $cache_key, $term_cache, 'term-queries' );
+                }
+
                 $this->terms = $this->format_terms( $term_objects, $_fields );
 
@@ -1154 +1166 @@
                 $cache_args = wp_array_slice_assoc( $args, array_keys( $this->query_var_defaults ) );
 
-                unset( $cache_args['update_term_meta_cache'] );
+                unset( $cache_args['cache_results'], $cache_args['update_term_meta_cache'] );
 
                 if ( 'count' !== $args['fields'] && 'all_with_object_id' !== $args['fields'] ) {

trunk/src/wp-includes/taxonomy.php

@@ -1542 +1542 @@
         // Ensure that while importing, queries are not cached.
         if ( ! empty( $_wp_suspend_cache_invalidation ) ) {
-                // @todo Disable caching once #52710 is merged.
-                $defaults['cache_domain'] = microtime();
+                $defaults['cache_results'] = false;
         }
 

trunk/tests/phpunit/tests/term/getTerms.php

@@ -3027 +3027 @@
 
         /**
+         * @ticket 52710
+         */
+        public function test_get_terms_without_update_get_terms_cache() {
+                $this->set_up_three_posts_and_tags();
+
+                $num_queries = get_num_queries();
+
+                // last_changed and num_queries should bump.
+                $terms = get_terms(
+                        'post_tag',
+                        array(
+                                'cache_results'          => false,
+                                'update_term_meta_cache' => false,
+                        )
+                );
+                $this->assertCount( 3, $terms, 'After running get_terms, 3 terms should be returned' );
+                $this->assertSame( $num_queries + 2, get_num_queries(), 'There should be only 2 queries run, only term query and priming terms' );
+
+                $num_queries = get_num_queries();
+
+                // last_changed and num_queries should bump again.
+                $terms = get_terms(
+                        'post_tag',
+                        array(
+                                'cache_results'          => false,
+                                'update_term_meta_cache' => false,
+                        )
+                );
+                $this->assertCount( 3, $terms, 'After running get_terms for a second time, 3 terms should be returned' );
+                $this->assertSame( $num_queries + 1, get_num_queries(), 'On the second run, only run the term query, priming terms happens on the first run' );
+        }
+
+        /**
          * @ticket 35935
          */