<!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>[52708] trunk/src/wp-includes: Docs: Improve `@return` tags for `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/52708">52708</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/52708","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-02-11 19:19:57 +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'>Docs: Improve `@return` tags for `wp_cache_*_multiple()` functions:
* `wp_cache_add_multiple()`
* `wp_cache_set_multiple()`
* `wp_cache_get_multiple()`
* `wp_cache_delete_multiple()`
This aims to provide more details about the returned value types.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/52700">[52700]</a>, <a href="https://core.trac.wordpress.org/changeset/52702">[52702]</a>, <a href="https://core.trac.wordpress.org/changeset/52703">[52703]</a>.
See <a href="https://core.trac.wordpress.org/ticket/54729">#54729</a>, <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>
</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 18:50:08 UTC (rev 52707)
+++ trunk/src/wp-includes/cache-compat.php 2022-02-11 19:19:57 UTC (rev 52708)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,7 +23,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $expire Optional. When to expire the cache contents, in seconds.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 0 (no expiration).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of return values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool[] Array of return values, grouped by key. Each value is either
+ * true on success, or false if cache key and group already exist.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_add_multiple( array $data, $group = '', $expire = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $values = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -53,7 +54,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $expire Optional. When to expire the cache contents, in seconds.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 0 (no expiration).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of return values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool[] Array of return values, grouped by key. Each value is either
+ * true on success, or false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_set_multiple( array $data, $group = '', $expire = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $values = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,7 +83,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $force Optional. Whether to force an update of the local cache
</span><span class="cx" style="display: block; padding: 0 10px"> * from the persistent cache. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of values organized into groups.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array Array of return values, grouped by key. Each value is either
+ * the cache contents on success, or false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_get_multiple( $keys, $group = '', $force = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $values = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -107,7 +110,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $keys Array of keys under which the cache to deleted.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of return values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool[] Array of return values, grouped by key. Each value is either
+ * true on success, or false if the contents were not deleted.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_delete_multiple( array $keys, $group = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $values = array();
</span></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 18:50:08 UTC (rev 52707)
+++ trunk/src/wp-includes/cache.php 2022-02-11 19:19:57 UTC (rev 52708)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,7 +56,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $expire Optional. When to expire the cache contents, in seconds.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 0 (no expiration).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of return values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool[] Array of return values, grouped by key. Each value is either
+ * true on success, or false if cache key and group already exist.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_add_multiple( array $data, $group = '', $expire = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_object_cache;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -122,7 +123,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $expire Optional. When to expire the cache contents, in seconds.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 0 (no expiration).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of return values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool[] Array of return values, grouped by key. Each value is either
+ * true on success, or false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_set_multiple( array $data, $group = '', $expire = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_object_cache;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,7 +166,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $force Optional. Whether to force an update of the local cache
</span><span class="cx" style="display: block; padding: 0 10px"> * from the persistent cache. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of values organized into groups.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array Array of return values, grouped by key. Each value is either
+ * the cache contents on success, or false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_get_multiple( $keys, $group = '', $force = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_object_cache;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -200,7 +203,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $keys Array of keys under which the cache to deleted.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of return values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool[] Array of return values, grouped by key. Each value is either
+ * true on success, or false if the contents were not deleted.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_delete_multiple( array $keys, $group = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_object_cache;
</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 18:50:08 UTC (rev 52707)
+++ trunk/src/wp-includes/class-wp-object-cache.php 2022-02-11 19:19:57 UTC (rev 52708)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -188,7 +188,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $expire Optional. When to expire the cache contents, in seconds.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 0 (no expiration).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of return values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool[] Array of return values, grouped by key. Each value is either
+ * true on success, or false if cache key and group already exist.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_multiple( array $data, $group = '', $expire = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $values = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -277,7 +278,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $expire Optional. When to expire the cache contents, in seconds.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 0 (no expiration).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of return values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool[] Array of return values, grouped by key. Each value is always true.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function set_multiple( array $data, $group = '', $expire = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $values = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -341,7 +342,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default 'default'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $force Optional. Whether to force an update of the local cache
</span><span class="cx" style="display: block; padding: 0 10px"> * from the persistent cache. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of values organized into groups.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array Array of return values, grouped by key. Each value is either
+ * the cache contents on success, or false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_multiple( $keys, $group = 'default', $force = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $values = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -389,7 +391,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $keys Array of keys to be deleted.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where the cache contents are grouped. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Array of return values.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool[] Array of return values, grouped by key. Each value is either
+ * true on success, or false if the contents were not deleted.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function delete_multiple( array $keys, $group = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $values = array();
</span></span></pre>
</div>
</div>
</body>
</html>