Changeset 55702

Timestamp:

05/02/2023 11:24:52 AM (17 months ago)

Author:

spacedmonkey

Message:

Cache API: Add helper function wp_cache_set_last_changed.

Add a helper function called wp_cache_set_last_changed to set the last changed value for cache groups. This function has a new action called wp_cache_set_last_changed, allowing for developers to cache invalidate when last changed value is changed.

Props tillkruess, spacedmonkey, peterwilsoncc, mukesh27, johnjamesjacoby.
Fixes #57905.

Location:

trunk/src/wp-includes

Files:

• comment.php (modified) (1 diff)
• functions.php (modified) (1 diff)
• ms-network.php (modified) (1 diff)
• ms-site.php (modified) (1 diff)
• post.php (modified) (1 diff)
• taxonomy.php (modified) (1 diff)
• user.php (modified) (1 diff)

trunk/src/wp-includes/comment.php

@@ -3919 +3919 @@
  */
 function wp_cache_set_comments_last_changed() {
-    wp_cache_set( 'last_changed', microtime(), 'comment' );
+    wp_cache_set_last_changed( 'comment' );
 }
 

trunk/src/wp-includes/functions.php

@@ -7681 +7681 @@
     $last_changed = wp_cache_get( 'last_changed', $group );
 
-    if ( ! $last_changed ) {
-        $last_changed = microtime();
-        wp_cache_set( 'last_changed', $last_changed, $group );
-    }
-
-    return $last_changed;
+    if ( $last_changed ) {
+        return $last_changed;
+    }
+
+    return wp_cache_set_last_changed( $group );
+}
+
+/**
+ * Sets last changed date for the specified cache group to now.
+ *
+ * @since 6.3.0
+ *
+ * @param string $group Where the cache contents are grouped.
+ * @return string UNIX timestamp when the group was last changed.
+ */
+function wp_cache_set_last_changed( $group ) {
+    $previous_time = wp_cache_get( 'last_changed', $group );
+
+    $time = microtime();
+
+    wp_cache_set( 'last_changed', $time, $group );
+
+    /**
+     * Fires after a cache group `last_changed` time is updated.
+     * This may occur multiple times per page load and registered
+     * actions must be performant.
+     *
+     * @since 6.3.0
+     *
+     * @param string    $group         The cache group name.
+     * @param int       $time          The new last changed time.
+     * @param int|false $previous_time The previous last changed time. False if not previously set.
+     */
+    do_action( 'wp_cache_set_last_changed', $group, $time, $previous_time );
+
+    return $time;
 }
 

trunk/src/wp-includes/ms-network.php

@@ -97 +97 @@
     }
 
-    wp_cache_set( 'last_changed', microtime(), 'networks' );
+    wp_cache_set_last_changed( 'networks' );
 }
 

trunk/src/wp-includes/ms-site.php

@@ -1282 +1282 @@
  */
 function wp_cache_set_sites_last_changed() {
-    wp_cache_set( 'last_changed', microtime(), 'sites' );
+    wp_cache_set_last_changed( 'sites' );
 }
 

trunk/src/wp-includes/post.php

@@ -7806 +7806 @@
  */
 function wp_cache_set_posts_last_changed() {
-    wp_cache_set( 'last_changed', microtime(), 'posts' );
+    wp_cache_set_last_changed( 'posts' );
 }
 

trunk/src/wp-includes/taxonomy.php

@@ -5039 +5039 @@
  */
 function wp_cache_set_terms_last_changed() {
-    wp_cache_set( 'last_changed', microtime(), 'terms' );
+    wp_cache_set_last_changed( 'terms' );
 }
 

trunk/src/wp-includes/user.php

@@ -5025 +5025 @@
  */
 function wp_cache_set_users_last_changed() {
-    wp_cache_set( 'last_changed', microtime(), 'users' );
-}
+    wp_cache_set_last_changed( 'users' );
+}