<!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>[52703] trunk/src/wp-includes: Docs: Update DocBlocks for some object cache functions per the documentation standards.</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/52703">52703</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/52703","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 17:42:51 +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: Update DocBlocks for some object cache functions per the documentation standards.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/47060">[47060]</a>, <a href="https://core.trac.wordpress.org/changeset/47938">[47938]</a>, <a href="https://core.trac.wordpress.org/changeset/47944">[47944]</a>, <a href="https://core.trac.wordpress.org/changeset/52700">[52700]</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 17:39:48 UTC (rev 52702)
+++ trunk/src/wp-includes/cache-compat.php 2022-02-11 17:42:51 UTC (rev 52703)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,7 +38,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! function_exists( 'wp_cache_delete_multiple' ) ) :
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Delete multiple values from the cache in one call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deletes multiple values from the cache in one call.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Compat function to mimic wp_cache_delete_multiple().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -65,7 +65,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! function_exists( 'wp_cache_add_multiple' ) ) :
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Add multiple values to the cache in one call, if the cache keys doesn't already exist.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds multiple values to the cache in one call, if the cache keys don't already exist.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Compat function to mimic wp_cache_add_multiple().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -74,9 +74,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see wp_cache_add_multiple()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @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).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $data Array of keys and values 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).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Array of return values.
</span><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="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,7 +93,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! function_exists( 'wp_cache_set_multiple' ) ) :
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Set multiple values to the cache in one call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets multiple values to the cache in one call.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Differs from wp_cache_add_multiple() in that it will always write data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -103,9 +104,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see wp_cache_set_multiple()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @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).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $data Array of keys and values 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).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Array of return values.
</span><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></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 17:39:48 UTC (rev 52702)
+++ trunk/src/wp-includes/cache.php 2022-02-11 17:42:51 UTC (rev 52703)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,7 +59,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Object_Cache $wp_object_cache Object cache global instance.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|string $key The cache key to decrement.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $offset Optional. The amount by which to decrement the item's value. Default 1.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $offset Optional. The amount by which to decrement the item's value.
+ * Default 1.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. The group the key is in. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int|false The item's new value on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,9 +146,8 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Delete multiple values from the cache in one call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deletes multiple values from the cache in one call.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,7 +156,7 @@
</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 organized into groups.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array Array of return values.
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,7 +165,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Add multiple values to the cache in one call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds multiple values to the cache in one call.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -172,10 +172,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Object_Cache::add_multiple()
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Object_Cache $wp_object_cache Object cache global instance.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $data Array of key and value to be set.
- * @param string $group Optional. Where the cache contents are grouped. Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $data Array of keys and values to be set.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $expire Optional. When to expire the cache contents, in seconds.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Default 0 (no expiration).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 0 (no expiration).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Array of return values.
</span><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="lines" style="display: block; padding: 0 10px; color: #888">@@ -185,7 +185,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Set multiple values to the cache in one call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets multiple values to the cache in one call.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,10 +192,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Object_Cache::set_multiple()
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Object_Cache $wp_object_cache Object cache global instance.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $data Array of key and value to be set.
- * @param string $group Optional. Where the cache contents are grouped. Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $data Array of keys and values to be set.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $expire Optional. When to expire the cache contents, in seconds.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Default 0 (no expiration).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default 0 (no expiration).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Array of return values.
</span><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="lines" style="display: block; padding: 0 10px; color: #888">@@ -205,7 +205,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Increment numeric cache item's value
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Increments numeric cache item's value.
</ins><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 class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,7 +213,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Object_Cache $wp_object_cache Object cache global instance.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|string $key The key for the cache contents that should be incremented.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $offset Optional. The amount by which to increment the item's value. Default 1.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $offset Optional. The amount by which to increment the item's value.
+ * Default 1.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. The group the key is in. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int|false The item's new value on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -248,7 +249,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * 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 bool False if original value does not exist, true if contents were replaced
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if contents were replaced, false if original value does not exist.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_replace( $key, $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">@@ -335,8 +336,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * This function is deprecated. Use wp_cache_switch_to_blog() instead of this
</span><span class="cx" style="display: block; padding: 0 10px"> * function when preparing the cache for a blog switch. For clearing the cache
</span><span class="cx" style="display: block; padding: 0 10px"> * during unit tests, consider using wp_cache_init(). wp_cache_init() is not
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * recommended outside of unit tests as the performance penalty for using it is
- * high.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * recommended outside of unit tests as the performance penalty for using it is high.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @deprecated 3.5.0 WP_Object_Cache::reset()
</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 17:39:48 UTC (rev 52702)
+++ trunk/src/wp-includes/class-wp-object-cache.php 2022-02-11 17:42:51 UTC (rev 52703)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,7 +141,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|string $key What to call the contents in the cache.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $data The contents to store in the cache.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where to group the cache contents. Default 'default'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $expire Optional. When to expire the cache contents. Default 0 (no expiration).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $expire Optional. When to expire the cache contents, in seconds.
+ * Default 0 (no expiration).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True on success, false if cache key and group already exist.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add( $key, $data, $group = 'default', $expire = 0 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -185,7 +186,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|string $key The cache key to decrement.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $offset Optional. The amount by which to decrement the item's value. Default 1.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $offset Optional. The amount by which to decrement the item's value.
+ * Default 1.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. The group the key is in. Default 'default'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int|false The item's new value on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -227,7 +229,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|string $key What the contents in the cache are called.
</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 $deprecated Optional. Unused. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool False if the contents weren't deleted and true on success.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True on success, 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( $key, $group = 'default', $deprecated = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $group ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -324,7 +326,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Delete multiple values from the cache in one call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deletes multiple values from the cache in one call.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -343,13 +345,14 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Add multiple values to the cache in one call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds multiple values to the cache in one call.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $data Array of key and value to be added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $data Array of keys and values to be added.
</ins><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">- * @param int $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $expire Optional. When to expire the cache contents, in seconds.
+ * Default 0 (no expiration).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Array of return values.
</span><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="lines" style="display: block; padding: 0 10px; color: #888">@@ -363,13 +366,14 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Set multiple values to the cache in one call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets multiple values to the cache in one call.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $data Array of key and value to be set.
</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">- * @param int $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $expire Optional. When to expire the cache contents, in seconds.
+ * Default 0 (no expiration).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Array of return values.
</span><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="lines" style="display: block; padding: 0 10px; color: #888">@@ -387,8 +391,9 @@
</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 class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|string $key The cache key to increment
- * @param int $offset Optional. The amount by which to increment the item's value. Default 1.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|string $key The cache key to increment.
+ * @param int $offset Optional. The amount by which to increment the item's value.
+ * Default 1.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. The group the key is in. Default 'default'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int|false The item's new value on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -430,8 +435,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|string $key What to call the contents in the cache.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $data The contents to store in the cache.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where to group the cache contents. Default 'default'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $expire Optional. When to expire the cache contents. Default 0 (no expiration).
- * @return bool False if not exists, true if contents were replaced.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $expire Optional. When to expire the cache contents, in seconds.
+ * Default 0 (no expiration).
+ * @return bool True if contents were replaced, false if original value does not exist.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function replace( $key, $data, $group = 'default', $expire = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $group ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -486,7 +492,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|string $key What to call the contents in the cache.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $data The contents to store in the cache.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $group Optional. Where to group the cache contents. Default 'default'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $expire Not Used.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $expire Optional. Not used.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return true Always returns true.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function set( $key, $data, $group = 'default', $expire = 0 ) {
</span></span></pre>
</div>
</div>
</body>
</html>