Replace direct cache operations with query-specific functions

Introduced `wp_cache_get_query_data` and `wp_cache_set_query_data` to handle cached query data with freshness validation. Refactored various classes, functions, and queries to use these standardized methods for improved readability and maintainability while ensuring cache consistency.

Author: spacedmonkey

src/wp-includes/class-wp-comment-query.php

@@ -451,8 +451,8 @@ public function get_comments() {
 		$key          = md5( serialize( $_args ) );
 		$last_changed = wp_cache_get_last_changed( 'comment' );
 
-		$cache_key   = "get_comments:$key:$last_changed";
-		$cache_value = wp_cache_get( $cache_key, 'comment-queries' );
+		$cache_key   = "get_comments:$key";
+		$cache_value = wp_cache_get_query_data( $cache_key, 'comment-queries', $last_changed );
 		if ( false === $cache_value ) {
 			$comment_ids = $this->get_comment_ids();
 			if ( $comment_ids ) {
@@ -463,7 +463,7 @@ public function get_comments() {
 				'comment_ids'    => $comment_ids,
 				'found_comments' => $this->found_comments,
 			);
-			wp_cache_add( $cache_key, $cache_value, 'comment-queries' );
+			wp_cache_set_query_data( $cache_key, $cache_value, 'comment-queries', $last_changed );
 		} else {
 			$comment_ids          = $cache_value['comment_ids'];
 			$this->found_comments = $cache_value['found_comments'];
@@ -1046,9 +1046,9 @@ protected function fill_descendants( $comments ) {
 			if ( $_parent_ids ) {
 				$cache_keys = array();
 				foreach ( $_parent_ids as $parent_id ) {
-					$cache_keys[ $parent_id ] = "get_comment_child_ids:$parent_id:$key:$last_changed";
+					$cache_keys[ $parent_id ] = "get_comment_child_ids:$parent_id:$key";
 				}
-				$cache_data = wp_cache_get_multiple( array_values( $cache_keys ), 'comment-queries' );
+				$cache_data = wp_cache_get_multiple_query_data( array_values( $cache_keys ), 'comment-queries', $last_changed );
 				foreach ( $_parent_ids as $parent_id ) {
 					$parent_child_ids = $cache_data[ $cache_keys[ $parent_id ] ];
 					if ( false !== $parent_child_ids ) {
@@ -1082,10 +1082,10 @@ protected function fill_descendants( $comments ) {
 
 				$data = array();
 				foreach ( $parent_map as $parent_id => $children ) {
-					$cache_key          = "get_comment_child_ids:$parent_id:$key:$last_changed";
+					$cache_key          = "get_comment_child_ids:$parent_id:$key";
 					$data[ $cache_key ] = $children;
 				}
-				wp_cache_set_multiple( $data, 'comment-queries' );
+				wp_cache_set_multiple_query_data( $data, 'comment-queries', $last_changed );
 			}
 
 			++$level;

src/wp-includes/class-wp-network-query.php

@@ -249,8 +249,8 @@ public function get_networks() {
 		$key          = md5( serialize( $_args ) );
 		$last_changed = wp_cache_get_last_changed( 'networks' );
 
-		$cache_key   = "get_network_ids:$key:$last_changed";
-		$cache_value = wp_cache_get( $cache_key, 'network-queries' );
+		$cache_key   = "get_network_ids:$key";
+		$cache_value = wp_cache_get_query_data( $cache_key, 'network-queries', $last_changed );
 
 		if ( false === $cache_value ) {
 			$network_ids = $this->get_network_ids();
@@ -262,7 +262,7 @@ public function get_networks() {
 				'network_ids'    => $network_ids,
 				'found_networks' => $this->found_networks,
 			);
-			wp_cache_add( $cache_key, $cache_value, 'network-queries' );
+			wp_cache_set_query_data( $cache_key, $cache_value, 'network-queries', $last_changed );
 		} else {
 			$network_ids          = $cache_value['network_ids'];
 			$this->found_networks = $cache_value['found_networks'];

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

@@ -2884,11 +2884,11 @@ public function get_posts() {
 			$key          = md5( $comments_request );
 			$last_changed = wp_cache_get_last_changed( 'comment' ) . ':' . wp_cache_get_last_changed( 'posts' );
 
-			$cache_key   = "comment_feed:$key:$last_changed";
-			$comment_ids = wp_cache_get( $cache_key, 'comment-queries' );
+			$cache_key   = "comment_feed:$key";
+			$comment_ids = wp_cache_get_query_data( $cache_key, 'comment-queries', $last_changed );
 			if ( false === $comment_ids ) {
 				$comment_ids = $wpdb->get_col( $comments_request );
-				wp_cache_add( $cache_key, $comment_ids, 'comment-queries' );
+				wp_cache_set_query_data( $cache_key, $comment_ids, 'comment-queries', $last_changed );
 			}
 			_prime_comment_caches( $comment_ids );
 
@@ -3246,15 +3246,21 @@ public function get_posts() {
 			$id_query_is_cacheable = false;
 		}
 
+		$last_changed = wp_cache_get_last_changed( 'posts' );
+		if ( ! empty( $this->tax_query->queries ) ) {
+			$last_changed .= wp_cache_get_last_changed( 'terms' );
+		}
+
 		if ( $q['cache_results'] && $id_query_is_cacheable ) {
 			$new_request = str_replace( $fields, "{$wpdb->posts}.*", $this->request );
 			$cache_key   = $this->generate_cache_key( $q, $new_request );
 
 			$cache_found = false;
 			if ( null === $this->posts ) {
-				$cached_results = wp_cache_get( $cache_key, 'post-queries', false, $cache_found );
+				$cached_results = wp_cache_get_query_data( $cache_key, 'post-queries', $last_changed );
 
 				if ( $cached_results ) {
+					$cache_found = true;
 					/** @var int[] */
 					$post_ids = array_map( 'intval', $cached_results['posts'] );
 
@@ -3312,7 +3318,7 @@ public function get_posts() {
 					'max_num_pages' => $this->max_num_pages,
 				);
 
-				wp_cache_set( $cache_key, $cache_value, 'post-queries' );
+				wp_cache_set_query_data( $cache_key, $cache_value, 'post-queries', $last_changed );
 			}
 
 			return $this->posts;
@@ -3486,11 +3492,11 @@ public function get_posts() {
 			$comment_key          = md5( $comments_request );
 			$comment_last_changed = wp_cache_get_last_changed( 'comment' );
 
-			$comment_cache_key = "comment_feed:$comment_key:$comment_last_changed";
-			$comment_ids       = wp_cache_get( $comment_cache_key, 'comment-queries' );
+			$comment_cache_key = "comment_feed:$comment_key";
+			$comment_ids       = wp_cache_get_query_data( $comment_cache_key, 'comment-queries', $comment_last_changed );
 			if ( false === $comment_ids ) {
 				$comment_ids = $wpdb->get_col( $comments_request );
-				wp_cache_add( $comment_cache_key, $comment_ids, 'comment-queries' );
+				wp_cache_set_query_data( $comment_cache_key, $comment_ids, 'comment-queries', $comment_last_changed );
 			}
 			_prime_comment_caches( $comment_ids );
 
@@ -5062,12 +5068,7 @@ static function ( &$value ) use ( $wpdb, $placeholder ) {
 		$sql = $wpdb->remove_placeholder_escape( $sql );
 		$key = md5( serialize( $args ) . $sql );
 
-		$last_changed = wp_cache_get_last_changed( 'posts' );
-		if ( ! empty( $this->tax_query->queries ) ) {
-			$last_changed .= wp_cache_get_last_changed( 'terms' );
-		}
-
-		$this->query_cache_key = "wp_query:$key:$last_changed";
+		$this->query_cache_key = "wp_query:$key";
 		return $this->query_cache_key;
 	}
 

src/wp-includes/class-wp-site-query.php

@@ -357,8 +357,8 @@ public function get_sites() {
 		$key          = md5( serialize( $_args ) );
 		$last_changed = wp_cache_get_last_changed( 'sites' );
 
-		$cache_key   = "get_sites:$key:$last_changed";
-		$cache_value = wp_cache_get( $cache_key, 'site-queries' );
+		$cache_key   = "get_sites:$key";
+		$cache_value = wp_cache_get_query_data( $cache_key, 'site-queries', $last_changed );
 
 		if ( false === $cache_value ) {
 			$site_ids = $this->get_site_ids();
@@ -370,7 +370,7 @@ public function get_sites() {
 				'site_ids'    => $site_ids,
 				'found_sites' => $this->found_sites,
 			);
-			wp_cache_add( $cache_key, $cache_value, 'site-queries' );
+			wp_cache_set_query_data( $cache_key, $cache_value, 'site-queries', $last_changed );
 		} else {
 			$site_ids          = $cache_value['site_ids'];
 			$this->found_sites = $cache_value['found_sites'];

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

@@ -777,8 +777,9 @@ public function get_terms() {
 		}
 
 		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_query_data( $cache_key, 'term-queries', $last_changed );
 
 			if ( false !== $cache ) {
 				if ( 'ids' === $_fields ) {
@@ -806,7 +807,7 @@ public function get_terms() {
 		if ( 'count' === $_fields ) {
 			$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_query_data( $cache_key, $count, 'term-queries', $last_changed );
 			}
 			return $count;
 		}
@@ -815,7 +816,7 @@ public function get_terms() {
 
 		if ( empty( $terms ) ) {
 			if ( $args['cache_results'] ) {
-				wp_cache_add( $cache_key, array(), 'term-queries' );
+				wp_cache_set_query_data( $cache_key, array(), 'term-queries', $last_changed );
 			}
 			return array();
 		}
@@ -899,7 +900,7 @@ public function get_terms() {
 		}
 
 		if ( $args['cache_results'] ) {
-			wp_cache_add( $cache_key, $term_cache, 'term-queries' );
+			wp_cache_set_query_data( $cache_key, $term_cache, 'term-queries', $last_changed );
 		}
 
 		$this->terms = $this->format_terms( $term_objects, $_fields );
@@ -1171,8 +1172,8 @@ protected function generate_cache_key( array $args, $sql ) {
 		// Replace wpdb placeholder in the SQL statement used by the cache key.
 		$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";
 	}
 }

src/wp-includes/class-wp-user-query.php

@@ -830,8 +830,38 @@ public function query() {
 			$cache_value   = false;
 			$cache_key     = $this->generate_cache_key( $qv, $this->request );
 			$cache_group   = 'user-queries';
+			$last_changed  = wp_cache_get_last_changed( 'users' );
+
+			if ( empty( $qv['orderby'] ) ) {
+				// Default order is by 'user_login'.
+				$ordersby = array( 'user_login' => '' );
+			} elseif ( is_array( $qv['orderby'] ) ) {
+				$ordersby = $qv['orderby'];
+			} else {
+				// 'orderby' values may be a comma- or space-separated list.
+				$ordersby = preg_split( '/[,\s]+/', $qv['orderby'] );
+			}
+
+			$blog_id = 0;
+			if ( isset( $qv['blog_id'] ) ) {
+				$blog_id = absint( $qv['blog_id'] );
+			}
+
+			if ( $qv['has_published_posts'] || in_array( 'post_count', $ordersby, true ) ) {
+				$switch = $blog_id && get_current_blog_id() !== $blog_id;
+				if ( $switch ) {
+					switch_to_blog( $blog_id );
+				}
+
+				$last_changed .= wp_cache_get_last_changed( 'posts' );
+
+				if ( $switch ) {
+					restore_current_blog();
+				}
+			}
+
 			if ( $qv['cache_results'] ) {
-				$cache_value = wp_cache_get( $cache_key, $cache_group );
+				$cache_value = wp_cache_get_query_data( $cache_key, $cache_group, $last_changed );
 			}
 			if ( false !== $cache_value ) {
 				$this->results     = $cache_value['user_data'];
@@ -866,7 +896,7 @@ public function query() {
 						'user_data'   => $this->results,
 						'total_users' => $this->total_users,
 					);
-					wp_cache_add( $cache_key, $cache_value, $cache_group );
+					wp_cache_set_query_data( $cache_key, $cache_value, $cache_group, $last_changed );
 				}
 			}
 		}
@@ -1056,38 +1086,9 @@ protected function generate_cache_key( array $args, $sql ) {
 		// Replace wpdb placeholder in the SQL statement used by the cache key.
 		$sql = $wpdb->remove_placeholder_escape( $sql );
 
-		$key          = md5( $sql );
-		$last_changed = wp_cache_get_last_changed( 'users' );
-
-		if ( empty( $args['orderby'] ) ) {
-			// Default order is by 'user_login'.
-			$ordersby = array( 'user_login' => '' );
-		} elseif ( is_array( $args['orderby'] ) ) {
-			$ordersby = $args['orderby'];
-		} else {
-			// 'orderby' values may be a comma- or space-separated list.
-			$ordersby = preg_split( '/[,\s]+/', $args['orderby'] );
-		}
-
-		$blog_id = 0;
-		if ( isset( $args['blog_id'] ) ) {
-			$blog_id = absint( $args['blog_id'] );
-		}
-
-		if ( $args['has_published_posts'] || in_array( 'post_count', $ordersby, true ) ) {
-			$switch = $blog_id && get_current_blog_id() !== $blog_id;
-			if ( $switch ) {
-				switch_to_blog( $blog_id );
-			}
-
-			$last_changed .= wp_cache_get_last_changed( 'posts' );
-
-			if ( $switch ) {
-				restore_current_blog();
-			}
-		}
+		$key = md5( $sql );
 
-		return "get_users:$key:$last_changed";
+		return "get_users:$key";
 	}
 
 	/**

src/wp-includes/functions.php

@@ -8061,6 +8061,89 @@ function wp_unique_id_from_values( array $data, string $prefix = '' ): string {
 	return $prefix . $hash;
 }
 
+/**
+ * Retrieves cached query data if valid and unchanged.
+ *
+ * @param string $cache_key The cache key used for storage and retrieval.
+ * @param string $group The cache group used for organizing data.
+ * @param string $last_changed The timestamp of the last modification to the cache group.
+ * @return mixed|false The cached data if valid, or false if the cache does not exist or is outdated.
+ */
+function wp_cache_get_query_data( $cache_key, $group, $last_changed ) {
+	$cache = wp_cache_get( $cache_key, $group );
+
+	if ( false === $cache ) {
+		return false;
+	}
+
+	if ( $last_changed !== $cache['last_changed'] ) {
+		return false;
+	}
+
+	return $cache['data'];
+}
+
+/**
+ * Stores query-related data in the cache.
+ *
+ * @param string $cache_key The cache key under which to store the data.
+ * @param mixed $data The data to be cached.
+ * @param string $group The cache group to which the data belongs.
+ * @param string $last_changed The timestamp or identifier indicating the last change to the cached data.
+ */
+function wp_cache_set_query_data( $cache_key, $data, $group, $last_changed ) {
+	wp_cache_set(
+		$cache_key,
+		array(
+			'data'         => $data,
+			'last_chagned' => $last_changed,
+		),
+		$group
+	);
+}
+
+/**
+ * Retrieves multiple items from the cache and validates their freshness.
+ *
+ * @param array $cache_keys Array of cache keys to retrieve.
+ * @param string $group The group of the cache to check.
+ * @param string $last_changed The timestamp of the last cache modification for validation.
+ * @return array An associative array containing cache values. Values are `false` if they are not found or outdated.
+ */
+function wp_cache_get_multiple_query_data( $cache_keys, $group, $last_changed ) {
+	$cache = wp_cache_get_multiple( $cache_keys, $group );
+
+	foreach ( $cache as $key => $value ) {
+		if ( false === $value ) {
+			continue;
+		}
+		if ( $last_changed !== $value['last_changed'] ) {
+			$cache[ $key ] = false;
+		}
+	}
+
+	return $cache;
+}
+
+/**
+ * Stores multiple pieces of query data in the cache.
+ *
+ * @param array $cache_keys Array of cache keys to define the items to be stored.
+ * @param mixed $data Data to be stored in the cache for all keys.
+ * @param string $group Group to which the cached data belongs.
+ * @param string $last_changed Timestamp indicating the last modification time for the data.
+ */
+function wp_cache_set_multiple_query_data( $cache_keys, $data, $group, $last_changed ) {
+	$new_cache = array();
+	foreach ( $cache_keys as $key ) {
+		$new_cache[ $key ] = array(
+			'data'         => $data,
+			'last_changed' => $last_changed,
+		);
+	}
+	wp_cache_set_multiple( $new_cache, $group );
+}
+
 /**
  * Gets last changed date for the specified cache group.
  *