Changeset 60697 for trunk/src/wp-includes/class-wp-term-query.php

Timestamp:

08/31/2025 09:41:54 PM (5 months ago)

Author:

spacedmonkey

Message:

Caching API: Use consistent cache keys for query groups.

Query-based caches are now improved by reusing cache keys. Previously, cache keys for query caches were generated using the last_changed value as part of the key. This meant that whenever last_changed was updated, all the previously cached values for the group became unreachable.

The new approach allows WordPress to replace previously cached results that are known to be stale. The previous approach relied on the object cache backend evicting stale keys which is done at various levels of efficiency.

To address this, the following new helper functions have been introduced:

• wp_cache_get_salted
• wp_cache_set_salted
• wp_cache_get_multiple_salted
• wp_cache_set_multiple_salted

These functions provide a consistent way to get/set query caches. Instead of using the last_changed value as part of the cache key, it is now stored inside the cache value as a "salt". This allows cache keys to be reused, with values updated in place rather than relying on eviction of outdated entries.

Props spacedmonkey, peterwilsoncc, flixos90, sanchothefat, tillkruess, rmccue, mukesh27, adamsilverstein, owi, nickchomey.

File:

• trunk/src/wp-includes/class-wp-term-query.php (modified) (5 diffs)

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

@@ -778 +778 @@
 
         if ( $args['cache_results'] ) {
-            $cache_key = $this->generate_cache_key( $args, $this->request );
-            $cache     = wp_cache_get( $cache_key, 'term-queries' );
+            $cache_key    = $this->generate_cache_key( $args, $this->request );
+            $last_changed = wp_cache_get_last_changed( 'terms' );
+            $cache        = wp_cache_get_salted( $cache_key, 'term-queries', $last_changed );
 
             if ( false !== $cache ) {
@@ -807 +808 @@
             $count = $wpdb->get_var( $this->request ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
             if ( $args['cache_results'] ) {
-                wp_cache_set( $cache_key, $count, 'term-queries' );
+                wp_cache_set_salted( $cache_key, $count, 'term-queries', $last_changed );
             }
             return $count;
@@ -816 +817 @@
         if ( empty( $terms ) ) {
             if ( $args['cache_results'] ) {
-                wp_cache_add( $cache_key, array(), 'term-queries' );
+                wp_cache_set_salted( $cache_key, array(), 'term-queries', $last_changed );
             }
             return array();
@@ -901 +902 @@
 
         if ( $args['cache_results'] ) {
-            wp_cache_add( $cache_key, $term_cache, 'term-queries' );
+            wp_cache_set_salted( $cache_key, $term_cache, 'term-queries', $last_changed );
         }
 
@@ -1173 +1174 @@
         $sql = $wpdb->remove_placeholder_escape( $sql );
 
-        $key          = md5( serialize( $cache_args ) . $sql );
-        $last_changed = wp_cache_get_last_changed( 'terms' );
-        return "get_terms:$key:$last_changed";
+        $key = md5( serialize( $cache_args ) . $sql );
+
+        return "get_terms:$key";
     }
 }