<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[52700] trunk: Cache: Add `wp_cache_*_multiple` functions.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/52700">52700</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/52700","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-02-11 12:50:54 +0000 (Fri, 11 Feb 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Cache: Add `wp_cache_*_multiple` functions.
Add new caching functions named `wp_cache_add_multiple`, `wp_cache_set_multiple` and `wp_cache_delete_multiple`. All of these functions allow for an array of data to be passed, so that multiple cache objects can be created / edited / deleted in a single function call. This follows on from <a href="https://core.trac.wordpress.org/changeset/47938">[47938]</a> where the `wp_cache_get_multiple` function was introduced and allowed for multiple cache objects to be received in one call.
Props: spacedmonkey, tillkruess, adamsilverstein, flixos90, mitogh, pbearne.
Fixes: <a href="https://core.trac.wordpress.org/ticket/54574">#54574</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescachecompatphp">trunk/src/wp-includes/cache-compat.php</a></li>
<li><a href="#trunksrcwpincludescachephp">trunk/src/wp-includes/cache.php</a></li>
<li><a href="#trunksrcwpincludesclasswpobjectcachephp">trunk/src/wp-includes/class-wp-object-cache.php</a></li>
<li><a href="#trunktestsphpunittestscachephp">trunk/tests/phpunit/tests/cache.php</a></li>
<li><a href="#trunktestsphpunittestspluggablephp">trunk/tests/phpunit/tests/pluggable.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescachecompatphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/cache-compat.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/cache-compat.php 2022-02-11 12:12:56 UTC (rev 52699)
+++ trunk/src/wp-includes/cache-compat.php 2022-02-11 12:50:54 UTC (rev 52700)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,3 +35,86 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $values;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> endif;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+if ( ! function_exists( 'wp_cache_delete_multiple' ) ) :
+ /**
+ * Delete multiple values from the cache in one call.
+ *
+ * Compat function to mimic wp_cache_delete_multiple().
+ *
+ * @ignore
+ * @since 6.0.0
+ *
+ * @see wp_cache_delete_multiple()
+ *
+ * @param array $keys Array of keys under which the cache to deleted.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @return array Array of return values.
+ */
+ function wp_cache_delete_multiple( array $keys, $group = '' ) {
+ $values = array();
+
+ foreach ( $keys as $key ) {
+ $values[ $key ] = wp_cache_delete( $key, $group );
+ }
+
+ return $values;
+ }
+endif;
+
+
+if ( ! function_exists( 'wp_cache_add_multiple' ) ) :
+ /**
+ * Add multiple values to the cache in one call, if the cache keys doesn't already exist.
+ *
+ * Compat function to mimic wp_cache_add_multiple().
+ *
+ * @ignore
+ * @since 6.0.0
+ *
+ * @see wp_cache_add_multiple()
+ *
+ * @param array $data Array of key and value to be added.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @param int $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
+ * @return array Array of return values.
+ */
+ function wp_cache_add_multiple( array $data, $group = '', $expire = 0 ) {
+ $values = array();
+
+ foreach ( $data as $key => $value ) {
+ $values[ $key ] = wp_cache_add( $key, $value, $group, $expire );
+ }
+
+ return $values;
+ }
+endif;
+
+if ( ! function_exists( 'wp_cache_set_multiple' ) ) :
+ /**
+ * Set multiple values to the cache in one call.
+ *
+ * Differs from wp_cache_add_multiple() in that it will always write data.
+ *
+ * Compat function to mimic wp_cache_set_multiple().
+ *
+ * @ignore
+ * @since 6.0.0
+ *
+ * @see wp_cache_set_multiple()
+ *
+ * @param array $data Array of key and value to be set.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @param int $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
+ * @return array Array of return values.
+ */
+ function wp_cache_set_multiple( array $data, $group = '', $expire = 0 ) {
+ $values = array();
+
+ foreach ( $data as $key => $value ) {
+ $values[ $key ] = wp_cache_set( $key, $value, $group, $expire );
+ }
+
+ return $values;
+ }
+endif;
</ins></span></pre></div>
<a id="trunksrcwpincludescachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/cache.php 2022-02-11 12:12:56 UTC (rev 52699)
+++ trunk/src/wp-includes/cache.php 2022-02-11 12:50:54 UTC (rev 52700)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,7 +145,66 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $wp_object_cache->get_multiple( $keys, $group, $force );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Delete multiple values from the cache in one call.
+ *
+ * @since 6.0.0
+ *
+ * @see WP_Object_Cache::delete_multiple()
+ * @global WP_Object_Cache $wp_object_cache Object cache global instance.
+ *
+ * @param array $keys Array of keys under which the cache to deleted.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @return array Array of return values organized into groups.
+ */
+function wp_cache_delete_multiple( array $keys, $group = '' ) {
+ global $wp_object_cache;
+
+ return $wp_object_cache->delete_multiple( $keys, $group );
+}
+
+/**
+ * Add multiple values to the cache in one call.
+ *
+ * @since 6.0.0
+ *
+ * @see WP_Object_Cache::add_multiple()
+ * @global WP_Object_Cache $wp_object_cache Object cache global instance.
+ *
+ * @param array $data Array of key and value to be set.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @param int $expire Optional. When to expire the cache contents, in seconds.
+ * Default 0 (no expiration).
+ * @return array Array of return values.
+ */
+function wp_cache_add_multiple( array $data, $group = '', $expire = 0 ) {
+ global $wp_object_cache;
+
+ return $wp_object_cache->add_multiple( $data, $group, $expire );
+}
+
+/**
+ * Set multiple values to the cache in one call.
+ *
+ * @since 6.0.0
+ *
+ * @see WP_Object_Cache::set_multiple()
+ * @global WP_Object_Cache $wp_object_cache Object cache global instance.
+ *
+ * @param array $data Array of key and value to be set.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @param int $expire Optional. When to expire the cache contents, in seconds.
+ * Default 0 (no expiration).
+ * @return array Array of return values.
+ */
+function wp_cache_set_multiple( array $data, $group = '', $expire = 0 ) {
+ global $wp_object_cache;
+
+ return $wp_object_cache->set_multiple( $data, $group, $expire );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Increment numeric cache item's value
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.3.0
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpobjectcachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-object-cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-object-cache.php 2022-02-11 12:12:56 UTC (rev 52699)
+++ trunk/src/wp-includes/class-wp-object-cache.php 2022-02-11 12:50:54 UTC (rev 52700)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -324,6 +324,65 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Delete multiple values from the cache in one call.
+ *
+ * @since 6.0.0
+ *
+ * @param array $keys Array of keys to be deleted.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @return array Array of return values.
+ */
+ public function delete_multiple( array $keys, $group = '' ) {
+ $values = array();
+
+ foreach ( $keys as $key ) {
+ $values[ $key ] = $this->delete( $key, $group );
+ }
+
+ return $values;
+ }
+
+ /**
+ * Add multiple values to the cache in one call.
+ *
+ * @since 6.0.0
+ *
+ * @param array $data Array of key and value to be added.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @param int $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
+ * @return array Array of return values.
+ */
+ public function add_multiple( array $data, $group = '', $expire = 0 ) {
+ $values = array();
+
+ foreach ( $data as $key => $value ) {
+ $values[ $key ] = $this->add( $key, $value, $group, $expire );
+ }
+
+ return $values;
+ }
+
+ /**
+ * Set multiple values to the cache in one call.
+ *
+ * @since 6.0.0
+ *
+ * @param array $data Array of key and value to be set.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @param int $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
+ * @return array Array of return values.
+ */
+ public function set_multiple( array $data, $group = '', $expire = 0 ) {
+ $values = array();
+
+ foreach ( $data as $key => $value ) {
+ $values[ $key ] = $this->set( $key, $value, $group, $expire );
+ }
+
+ return $values;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Increments numeric cache item's value.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.3.0
</span></span></pre></div>
<a id="trunktestsphpunittestscachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/cache.php 2022-02-11 12:12:56 UTC (rev 52699)
+++ trunk/tests/phpunit/tests/cache.php 2022-02-11 12:50:54 UTC (rev 52700)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -349,4 +349,74 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, $found );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 54574
+ */
+ public function test_wp_cache_add_multiple() {
+ $found = wp_cache_add_multiple(
+ array(
+ 'foo1' => 'bar',
+ 'foo2' => 'bar',
+ 'foo3' => 'bar',
+ ),
+ 'group1'
+ );
+
+ $expected = array(
+ 'foo1' => true,
+ 'foo2' => true,
+ 'foo3' => true,
+ );
+
+ $this->assertSame( $expected, $found );
+ }
+
+ /**
+ * @ticket 54574
+ */
+ public function test_wp_cache_set_multiple() {
+ wp_cache_set( 'foo1', 'bar', 'group1' );
+ wp_cache_set( 'foo2', 'bar', 'group1' );
+ wp_cache_set( 'foo3', 'bar', 'group2' );
+
+ $found = wp_cache_set_multiple(
+ array(
+ 'foo1' => 'bar',
+ 'foo2' => 'bar',
+ 'foo3' => 'bar',
+ ),
+ 'group1'
+ );
+
+ $expected = array(
+ 'foo1' => true,
+ 'foo2' => true,
+ 'foo3' => true,
+ );
+
+ $this->assertSame( $expected, $found );
+ }
+
+ /**
+ * @ticket 54574
+ */
+ public function test_wp_cache_delete_multiple() {
+ wp_cache_set( 'foo1', 'bar', 'group1' );
+ wp_cache_set( 'foo2', 'bar', 'group1' );
+ wp_cache_set( 'foo3', 'bar', 'group2' );
+
+ $found = wp_cache_delete_multiple(
+ array( 'foo1', 'foo2', 'foo3' ),
+ 'group1'
+ );
+
+ $expected = array(
+ 'foo1' => true,
+ 'foo2' => true,
+ 'foo3' => false,
+ );
+
+ $this->assertSame( $expected, $found );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestspluggablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/pluggable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/pluggable.php 2022-02-11 12:12:56 UTC (rev 52699)
+++ trunk/tests/phpunit/tests/pluggable.php 2022-02-11 12:50:54 UTC (rev 52700)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -295,6 +295,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'group' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'force' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp_cache_set_multiple' => array(
+ 'data',
+ 'group' => '',
+ 'expire' => 0,
+ ),
+ 'wp_cache_add_multiple' => array(
+ 'data',
+ 'group' => '',
+ 'expire' => 0,
+ ),
+ 'wp_cache_delete_multiple' => array(
+ 'keys',
+ 'group' => '',
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'wp_cache_incr' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'key',
</span><span class="cx" style="display: block; padding: 0 10px"> 'offset' => 1,
</span></span></pre>
</div>
</div>
</body>
</html>