Changeset 38849

Timestamp:

10/21/2016 02:53:19 AM (10 years ago)

Author:

jorbin

Message:

Cache API: introduce wp_cache_get_last_changed to improve DRY

One thing fairly common to the cache groups is a block of code to look to see when the cache was last changed, and if there isn't one, to set it for the current microtime(). It appears in 8 different places in core. This adds a new helper wp_cache_get_last_changed to DRY things up a bit.

Since wp-includes/cache.php isn't guaranteed to be loaded, this new function is in wp-includes/functions.php

Props spacedmonkey, desrosj.
Fixes #37464.

Location:

trunk/src/wp-includes

Files:

• class-wp-comment-query.php (modified) (2 diffs)
• class-wp-network-query.php (modified) (1 diff)
• class-wp-site-query.php (modified) (1 diff)
• class-wp-term-query.php (modified) (1 diff)
• functions.php (modified) (1 diff)
• general-template.php (modified) (1 diff)
• post.php (modified) (2 diffs)

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

@@ -394 +394 @@
                 // $args can include anything. Only use the args defined in the query_var_defaults to compute the key.
                 $key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) ) ) );
-                $last_changed = wp_cache_get( 'last_changed', 'comment' );
-                if ( ! $last_changed ) {
-                        $last_changed = microtime();
-                        wp_cache_set( 'last_changed', $last_changed, 'comment' );
-                }
+                $last_changed = wp_cache_get_last_changed( 'comment' );
+
 
                 $cache_key   = "get_comments:$key:$last_changed";
@@ -973 +970 @@
 
                 $key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) ) ) );
-                $last_changed = wp_cache_get( 'last_changed', 'comment' );
-                if ( ! $last_changed ) {
-                        $last_changed = microtime();
-                        wp_cache_set( 'last_changed', $last_changed, 'comment' );
-                }
+                $last_changed = wp_cache_get_last_changed( 'comment' );
 
                 // Fetch an entire level of the descendant tree at a time.

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

@@ -210 +210 @@
                 // $args can include anything. Only use the args defined in the query_var_defaults to compute the key.
                 $key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) ) ) );
-                $last_changed = wp_cache_get( 'last_changed', 'networks' );
-                if ( ! $last_changed ) {
-                        $last_changed = microtime();
-                        wp_cache_set( 'last_changed', $last_changed, 'networks' );
-                }
+                $last_changed = wp_cache_get_last_changed( 'networks' );
 
                 $cache_key = "get_network_ids:$key:$last_changed";

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

@@ -246 +246 @@
                 // $args can include anything. Only use the args defined in the query_var_defaults to compute the key.
                 $key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) ) ) );
-                $last_changed = wp_cache_get( 'last_changed', 'sites' );
-                if ( ! $last_changed ) {
-                        $last_changed = microtime();
-                        wp_cache_set( 'last_changed', $last_changed, 'sites' );
-                }
+                $last_changed = wp_cache_get_last_changed( 'sites' );
 
                 $cache_key = "get_sites:$key:$last_changed";

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

@@ -674 +674 @@
                 // $args can be anything. Only use the args defined in defaults to compute the key.
                 $key = md5( serialize( wp_array_slice_assoc( $args, array_keys( $this->query_var_defaults ) ) ) . serialize( $taxonomies ) . $this->request );
-                $last_changed = wp_cache_get( 'last_changed', 'terms' );
-                if ( ! $last_changed ) {
-                        $last_changed = microtime();
-                        wp_cache_set( 'last_changed', $last_changed, 'terms' );
-                }
+                $last_changed = wp_cache_get_last_changed( 'terms' );
                 $cache_key = "get_terms:$key:$last_changed";
                 $cache = wp_cache_get( $cache_key, 'terms' );

trunk/src/wp-includes/functions.php

@@ -5554 +5554 @@
         );
 }
+
+/**
+ * Get last changed date for the specified cache group.
+ *
+ * @since 4.7.0
+ *
+ * @param $group Where the cache contents are grouped.
+ *
+ * @return string $last_changed UNIX timestamp with microseconds representing when the group was last changed.
+ */
+function wp_cache_get_last_changed( $group ) {
+        $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;
+}

trunk/src/wp-includes/general-template.php

@@ -1714 +1714 @@
         $output = '';
 
-        $last_changed = wp_cache_get( 'last_changed', 'posts' );
-        if ( ! $last_changed ) {
-                $last_changed = microtime();
-                wp_cache_set( 'last_changed', $last_changed, 'posts' );
-        }
+        $last_changed = wp_cache_get_last_changed( 'posts' );
 
         $limit = $r['limit'];

trunk/src/wp-includes/post.php

@@ -4195 +4195 @@
         global $wpdb;
 
-        $last_changed = wp_cache_get( 'last_changed', 'posts' );
-        if ( false === $last_changed ) {
-                $last_changed = microtime();
-                wp_cache_set( 'last_changed', $last_changed, 'posts' );
-        }
+        $last_changed = wp_cache_get_last_changed( 'posts' );
 
         $hash = md5( $page_path . serialize( $post_type ) );
@@ -4541 +4537 @@
         // $args can be whatever, only use the args defined in defaults to compute the key.
         $key = md5( serialize( wp_array_slice_assoc( $r, array_keys( $defaults ) ) ) );
-        $last_changed = wp_cache_get( 'last_changed', 'posts' );
-        if ( ! $last_changed ) {
-                $last_changed = microtime();
-                wp_cache_set( 'last_changed', $last_changed, 'posts' );
-        }
+        $last_changed = wp_cache_get_last_changed( 'posts' );
 
         $cache_key = "get_pages:$key:$last_changed";