<!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>[32528] trunk/src/wp-includes/cache.php: In `cache.php`, clarify some `return` docs.</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 { 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/32528">32528</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/32528","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-21 20:21:22 +0000 (Thu, 21 May 2015)</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'>In `cache.php`, clarify some `return` docs. Some `WP_Object_Cache` methods return `void`, so those wrapper functions don't need to return at all.
See <a href="https://core.trac.wordpress.org/ticket/32444">#32444</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescachephp">trunk/src/wp-includes/cache.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2015-05-21 20:12:41 UTC (rev 32527)
+++ trunk/src/wp-includes/cache.php 2015-05-21 20:21:22 UTC (rev 32528)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -37,7 +37,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.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">- * @return bool Always returns True
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return true Always returns True
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_close() {
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -105,7 +105,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $force Whether to force an update of the local cache from the persistent cache (default is false)
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool &$found Whether key was found in the cache. Disambiguates a return of false, a storable value.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool|mixed False on failure to retrieve contents or the cache
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * contents on success
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * contents on success
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
</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">@@ -135,7 +135,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Sets up Object Cache Global and assigns it.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global WP_Object_Cache $wp_object_cache WordPress Object Cache
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global $wp_object_cache WordPress Object Cache instance
+ * @uses WP_Object_Cache
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_init() {
</span><span class="cx" style="display: block; padding: 0 10px"> $GLOBALS['wp_object_cache'] = new WP_Object_Cache();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,7 +193,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_switch_to_blog( $blog_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_object_cache;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $wp_object_cache->switch_to_blog( $blog_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_object_cache->switch_to_blog( $blog_id );
</ins><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -205,7 +206,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_cache_add_global_groups( $groups ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_object_cache;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $wp_object_cache->add_global_groups( $groups );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_object_cache->add_global_groups( $groups );
</ins><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,7 +240,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_object_cache;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $wp_object_cache->reset();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_object_cache->reset();
</ins><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -499,8 +500,8 @@
</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 Where the cache contents are grouped
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $force Whether to force a refetch rather than relying on the local cache (default is false)
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|mixed False on failure to retrieve contents or the cache
- * contents on success
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return false|mixed False on failure to retrieve contents or the cache
+ * contents on success
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get( $key, $group = 'default', $force = false, &$found = null ) {
</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">@@ -616,7 +617,7 @@
</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 Where to group the cache contents
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $expire Not Used
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool Always returns true
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return true Always returns true
</ins><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 class="cx" style="display: block; padding: 0 10px"> if ( empty( $group ) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -706,7 +707,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.8
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool True value. Won't be used by PHP
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return true True value. Won't be used by PHP
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __destruct() {
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span></span></pre>
</div>
</div>
</body>
</html>