<!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>[18644] trunk/wp-includes/cache.php: Standardize variable names.</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, #logmsg > ol { margin-left: 0; 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/18644">18644</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2011-09-06 21:13:11 +0000 (Tue, 06 Sep 2011)</dd>
</dl>
<h3>Log Message</h3>
<pre>Standardize variable names. Consistently use and . fixes <a href="http://core.trac.wordpress.org/ticket/18607">#18607</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludescachephp">trunk/wp-includes/cache.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludescachephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/cache.php (18643 => 18644)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/cache.php 2011-09-06 16:15:47 UTC (rev 18643)
+++ trunk/wp-includes/cache.php 2011-09-06 21:13:11 UTC (rev 18644)
</span><span class="lines">@@ -17,14 +17,14 @@
</span><span class="cx"> *
</span><span class="cx"> * @param int|string $key The cache ID to use for retrieval later
</span><span class="cx"> * @param mixed $data The data to add to the cache store
</span><del>- * @param string $flag The group to add the cache to
</del><ins>+ * @param string $group The group to add the cache to
</ins><span class="cx"> * @param int $expire When the cache data should be expired
</span><span class="cx"> * @return unknown
</span><span class="cx"> */
</span><del>-function wp_cache_add($key, $data, $flag = '', $expire = 0) {
</del><ins>+function wp_cache_add($key, $data, $group = '', $expire = 0) {
</ins><span class="cx"> global $wp_object_cache;
</span><span class="cx">
</span><del>- return $wp_object_cache->add($key, $data, $flag, $expire);
</del><ins>+ return $wp_object_cache->add($key, $data, $group, $expire);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -52,13 +52,13 @@
</span><span class="cx"> *
</span><span class="cx"> * @param int|string $key The cache ID to increment
</span><span class="cx"> * @param int $offset The amount by which to decrement the item's value. Default is 1.
</span><del>- * @param string $flag The group the key is in.
</del><ins>+ * @param string $group The group the key is in.
</ins><span class="cx"> * @return false|int False on failure, the item's new value on success.
</span><span class="cx"> */
</span><del>-function wp_cache_decr( $key, $offset = 1, $flag = '' ) {
</del><ins>+function wp_cache_decr( $key, $offset = 1, $group = '' ) {
</ins><span class="cx"> global $wp_object_cache;
</span><span class="cx">
</span><del>- return $wp_object_cache->decr( $key, $offset, $flag );
</del><ins>+ return $wp_object_cache->decr( $key, $offset, $group );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -68,14 +68,14 @@
</span><span class="cx"> * @uses $wp_object_cache Object Cache Class
</span><span class="cx"> * @see WP_Object_Cache::delete()
</span><span class="cx"> *
</span><del>- * @param int|string $id What the contents in the cache are called
- * @param string $flag Where the cache contents are grouped
</del><ins>+ * @param int|string $key What the contents in the cache are called
+ * @param string $group Where the cache contents are grouped
</ins><span class="cx"> * @return bool True on successful removal, false on failure
</span><span class="cx"> */
</span><del>-function wp_cache_delete($id, $flag = '') {
</del><ins>+function wp_cache_delete($key, $group = '') {
</ins><span class="cx"> global $wp_object_cache;
</span><span class="cx">
</span><del>- return $wp_object_cache->delete($id, $flag);
</del><ins>+ return $wp_object_cache->delete($key, $group);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -100,15 +100,15 @@
</span><span class="cx"> * @uses $wp_object_cache Object Cache Class
</span><span class="cx"> * @see WP_Object_Cache::get()
</span><span class="cx"> *
</span><del>- * @param int|string $id What the contents in the cache are called
- * @param string $flag Where the cache contents are grouped
</del><ins>+ * @param int|string $key What the contents in the cache are called
+ * @param string $group Where the cache contents are grouped
</ins><span class="cx"> * @return bool|mixed False on failure to retrieve contents or the cache
</span><span class="cx"> * contents on success
</span><span class="cx"> */
</span><del>-function wp_cache_get($id, $flag = '') {
</del><ins>+function wp_cache_get($key, $group = '') {
</ins><span class="cx"> global $wp_object_cache;
</span><span class="cx">
</span><del>- return $wp_object_cache->get($id, $flag);
</del><ins>+ return $wp_object_cache->get($key, $group);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -120,13 +120,13 @@
</span><span class="cx"> *
</span><span class="cx"> * @param int|string $key The cache ID to increment
</span><span class="cx"> * @param int $offset The amount by which to increment the item's value. Default is 1.
</span><del>- * @param string $flag The group the key is in.
</del><ins>+ * @param string $group The group the key is in.
</ins><span class="cx"> * @return false|int False on failure, the item's new value on success.
</span><span class="cx"> */
</span><del>-function wp_cache_incr( $key, $offset = 1, $flag = '' ) {
</del><ins>+function wp_cache_incr( $key, $offset = 1, $group = '' ) {
</ins><span class="cx"> global $wp_object_cache;
</span><span class="cx">
</span><del>- return $wp_object_cache->incr( $key, $offset, $flag );
</del><ins>+ return $wp_object_cache->incr( $key, $offset, $group );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -148,14 +148,14 @@
</span><span class="cx"> *
</span><span class="cx"> * @param int|string $key What to call the contents in the cache
</span><span class="cx"> * @param mixed $data The contents to store in the cache
</span><del>- * @param string $flag Where to group the cache contents
</del><ins>+ * @param string $group Where to group the cache contents
</ins><span class="cx"> * @param int $expire When to expire the cache contents
</span><span class="cx"> * @return bool False if cache ID and group already exists, true on success
</span><span class="cx"> */
</span><del>-function wp_cache_replace($key, $data, $flag = '', $expire = 0) {
</del><ins>+function wp_cache_replace($key, $data, $group = '', $expire = 0) {
</ins><span class="cx"> global $wp_object_cache;
</span><span class="cx">
</span><del>- return $wp_object_cache->replace($key, $data, $flag, $expire);
</del><ins>+ return $wp_object_cache->replace($key, $data, $group, $expire);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -167,14 +167,14 @@
</span><span class="cx"> *
</span><span class="cx"> * @param int|string $key What to call the contents in the cache
</span><span class="cx"> * @param mixed $data The contents to store in the cache
</span><del>- * @param string $flag Where to group the cache contents
</del><ins>+ * @param string $group Where to group the cache contents
</ins><span class="cx"> * @param int $expire When to expire the cache contents
</span><span class="cx"> * @return bool False if cache ID and group already exists, true on success
</span><span class="cx"> */
</span><del>-function wp_cache_set($key, $data, $flag = '', $expire = 0) {
</del><ins>+function wp_cache_set($key, $data, $group = '', $expire = 0) {
</ins><span class="cx"> global $wp_object_cache;
</span><span class="cx">
</span><del>- return $wp_object_cache->set($key, $data, $flag, $expire);
</del><ins>+ return $wp_object_cache->set($key, $data, $group, $expire);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -286,20 +286,20 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> *
</span><del>- * @param int|string $id What to call the contents in the cache
</del><ins>+ * @param int|string $key What to call the contents in the cache
</ins><span class="cx"> * @param mixed $data The contents to store in the cache
</span><span class="cx"> * @param string $group Where to group the cache contents
</span><span class="cx"> * @param int $expire When to expire the cache contents
</span><span class="cx"> * @return bool False if cache ID and group already exists, true on success
</span><span class="cx"> */
</span><del>- function add( $id, $data, $group = 'default', $expire = '' ) {
</del><ins>+ function add( $key, $data, $group = 'default', $expire = '' ) {
</ins><span class="cx"> if ( empty ($group) )
</span><span class="cx"> $group = 'default';
</span><span class="cx">
</span><del>- if (false !== $this->get($id, $group))
</del><ins>+ if (false !== $this->get($key, $group))
</ins><span class="cx"> return false;
</span><span class="cx">
</span><del>- return $this->set($id, $data, $group, $expire);
</del><ins>+ return $this->set($key, $data, $group, $expire);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -321,26 +321,26 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.3.0
</span><span class="cx"> *
</span><del>- * @param int|string $id The cache ID to increment
</del><ins>+ * @param int|string $key The cache ID to increment
</ins><span class="cx"> * @param int $offset The amount by which to decrement the item's value. Default is 1.
</span><del>- * @param string $flag The group the key is in.
</del><ins>+ * @param string $group The group the key is in.
</ins><span class="cx"> * @return false|int False on failure, the item's new value on success.
</span><span class="cx"> */
</span><del>- function decr( $id, $offset = 1, $group = 'default' ) {
- if ( ! isset( $this->cache[ $group ][ $id ] ) )
</del><ins>+ function decr( $key, $offset = 1, $group = 'default' ) {
+ if ( ! isset( $this->cache[ $group ][ $key ] ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><del>- if ( ! is_numeric( $this->cache[ $group ][ $id ] ) )
- $this->cache[ $group ][ $id ] = 0;
</del><ins>+ if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
+ $this->cache[ $group ][ $key ] = 0;
</ins><span class="cx">
</span><span class="cx"> $offset = (int) $offset;
</span><span class="cx">
</span><del>- $this->cache[ $group ][ $id ] -= $offset;
</del><ins>+ $this->cache[ $group ][ $key ] -= $offset;
</ins><span class="cx">
</span><del>- if ( $this->cache[ $group ][ $id ] < 0 )
- $this->cache[ $group ][ $id ] = 0;
</del><ins>+ if ( $this->cache[ $group ][ $key ] < 0 )
+ $this->cache[ $group ][ $key ] = 0;
</ins><span class="cx">
</span><del>- return $this->cache[ $group ][ $id ];
</del><ins>+ return $this->cache[ $group ][ $key ];
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -355,21 +355,21 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> *
</span><del>- * @param int|string $id What the contents in the cache are called
</del><ins>+ * @param int|string $key What the contents in the cache are called
</ins><span class="cx"> * @param string $group Where the cache contents are grouped
</span><span class="cx"> * @param bool $force Optional. Whether to force the unsetting of the cache
</span><span class="cx"> * ID in the group
</span><span class="cx"> * @return bool False if the contents weren't deleted and true on success
</span><span class="cx"> */
</span><del>- function delete($id, $group = 'default', $force = false) {
</del><ins>+ function delete($key, $group = 'default', $force = false) {
</ins><span class="cx"> if (empty ($group))
</span><span class="cx"> $group = 'default';
</span><span class="cx">
</span><del>- if (!$force && false === $this->get($id, $group))
</del><ins>+ if (!$force && false === $this->get($key, $group))
</ins><span class="cx"> return false;
</span><span class="cx">
</span><del>- unset ($this->cache[$group][$id]);
- $this->non_existent_objects[$group][$id] = true;
</del><ins>+ unset ($this->cache[$group][$key]);
+ $this->non_existent_objects[$group][$key] = true;
</ins><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -401,27 +401,27 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> *
</span><del>- * @param int|string $id What the contents in the cache are called
</del><ins>+ * @param int|string $key What the contents in the cache are called
</ins><span class="cx"> * @param string $group Where the cache contents are grouped
</span><span class="cx"> * @return bool|mixed False on failure to retrieve contents or the cache
</span><span class="cx"> * contents on success
</span><span class="cx"> */
</span><del>- function get($id, $group = 'default') {
</del><ins>+ function get($key, $group = 'default') {
</ins><span class="cx"> if ( empty ($group) )
</span><span class="cx"> $group = 'default';
</span><span class="cx">
</span><del>- if ( isset ($this->cache[$group][$id]) ) {
</del><ins>+ if ( isset ($this->cache[$group][$key]) ) {
</ins><span class="cx"> $this->cache_hits += 1;
</span><del>- if ( is_object($this->cache[$group][$id]) )
- return clone $this->cache[$group][$id];
</del><ins>+ if ( is_object($this->cache[$group][$key]) )
+ return clone $this->cache[$group][$key];
</ins><span class="cx"> else
</span><del>- return $this->cache[$group][$id];
</del><ins>+ return $this->cache[$group][$key];
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- if ( isset ($this->non_existent_objects[$group][$id]) )
</del><ins>+ if ( isset ($this->non_existent_objects[$group][$key]) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><del>- $this->non_existent_objects[$group][$id] = true;
</del><ins>+ $this->non_existent_objects[$group][$key] = true;
</ins><span class="cx"> $this->cache_misses += 1;
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="lines">@@ -431,26 +431,26 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.3.0
</span><span class="cx"> *
</span><del>- * @param int|string $id The cache ID to increment
</del><ins>+ * @param int|string $key The cache ID to increment
</ins><span class="cx"> * @param int $offset The amount by which to increment the item's value. Default is 1.
</span><del>- * @param string $flag The group the key is in.
</del><ins>+ * @param string $group The group the key is in.
</ins><span class="cx"> * @return false|int False on failure, the item's new value on success.
</span><span class="cx"> */
</span><del>- function incr( $id, $offset = 1, $group = 'default' ) {
- if ( ! isset( $this->cache[ $group ][ $id ] ) )
</del><ins>+ function incr( $key, $offset = 1, $group = 'default' ) {
+ if ( ! isset( $this->cache[ $group ][ $key ] ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><del>- if ( ! is_numeric( $this->cache[ $group ][ $id ] ) )
- $this->cache[ $group ][ $id ] = 0;
</del><ins>+ if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
+ $this->cache[ $group ][ $key ] = 0;
</ins><span class="cx">
</span><span class="cx"> $offset = (int) $offset;
</span><span class="cx">
</span><del>- $this->cache[ $group ][ $id ] += $offset;
</del><ins>+ $this->cache[ $group ][ $key ] += $offset;
</ins><span class="cx">
</span><del>- if ( $this->cache[ $group ][ $id ] < 0 )
- $this->cache[ $group ][ $id ] = 0;
</del><ins>+ if ( $this->cache[ $group ][ $key ] < 0 )
+ $this->cache[ $group ][ $key ] = 0;
</ins><span class="cx">
</span><del>- return $this->cache[ $group ][ $id ];
</del><ins>+ return $this->cache[ $group ][ $key ];
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -459,20 +459,20 @@
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> * @see WP_Object_Cache::set()
</span><span class="cx"> *
</span><del>- * @param int|string $id What to call the contents in the cache
</del><ins>+ * @param int|string $key What to call the contents in the cache
</ins><span class="cx"> * @param mixed $data The contents to store in the cache
</span><span class="cx"> * @param string $group Where to group the cache contents
</span><span class="cx"> * @param int $expire When to expire the cache contents
</span><span class="cx"> * @return bool False if not exists, true if contents were replaced
</span><span class="cx"> */
</span><del>- function replace($id, $data, $group = 'default', $expire = '') {
</del><ins>+ function replace($key, $data, $group = 'default', $expire = '') {
</ins><span class="cx"> if (empty ($group))
</span><span class="cx"> $group = 'default';
</span><span class="cx">
</span><del>- if ( false === $this->get($id, $group) )
</del><ins>+ if ( false === $this->get($key, $group) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><del>- return $this->set($id, $data, $group, $expire);
</del><ins>+ return $this->set($key, $data, $group, $expire);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -492,7 +492,7 @@
</span><span class="cx"> * Sets the data contents into the cache
</span><span class="cx"> *
</span><span class="cx"> * The cache contents is grouped by the $group parameter followed by the
</span><del>- * $id. This allows for duplicate ids in unique groups. Therefore, naming of
</del><ins>+ * $key. This allows for duplicate ids in unique groups. Therefore, naming of
</ins><span class="cx"> * the group should be used with care and should follow normal function
</span><span class="cx"> * naming guidelines outside of core WordPress usage.
</span><span class="cx"> *
</span><span class="lines">@@ -502,13 +502,13 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> *
</span><del>- * @param int|string $id What to call the contents in the cache
</del><ins>+ * @param int|string $key What to call the contents in the cache
</ins><span class="cx"> * @param mixed $data The contents to store in the cache
</span><span class="cx"> * @param string $group Where to group the cache contents
</span><span class="cx"> * @param int $expire Not Used
</span><span class="cx"> * @return bool Always returns true
</span><span class="cx"> */
</span><del>- function set($id, $data, $group = 'default', $expire = '') {
</del><ins>+ function set($key, $data, $group = 'default', $expire = '') {
</ins><span class="cx"> if ( empty ($group) )
</span><span class="cx"> $group = 'default';
</span><span class="cx">
</span><span class="lines">@@ -518,10 +518,10 @@
</span><span class="cx"> if ( is_object($data) )
</span><span class="cx"> $data = clone $data;
</span><span class="cx">
</span><del>- $this->cache[$group][$id] = $data;
</del><ins>+ $this->cache[$group][$key] = $data;
</ins><span class="cx">
</span><del>- if ( isset($this->non_existent_objects[$group][$id]) )
- unset ($this->non_existent_objects[$group][$id]);
</del><ins>+ if ( isset($this->non_existent_objects[$group][$key]) )
+ unset ($this->non_existent_objects[$group][$key]);
</ins><span class="cx">
</span><span class="cx"> return true;
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>