Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2025-01-18 14:21:25 +01:00
Code Issues Projects Releases Wiki Activity

Standardize variable names. Consistently use and . fixes #18607

Browse Source 
git-svn-id: http://svn.automattic.com/wordpress/trunk@18644 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
ryan 2011-09-06 21:13:11 +00:00
parent 9223d74720
commit 4410168419
1 changed files with 70 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
wp-includes/cache.php
View File

@ -17,14 +17,14 @@
* *
* @param int|string $key The cache ID to use for retrieval later * @param int|string $key The cache ID to use for retrieval later
* @param mixed $data The data to add to the cache store * @param mixed $data The data to add to the cache store
* @param string $flag The group to add the cache to * @param string $group The group to add the cache to
* @param int $expire When the cache data should be expired * @param int $expire When the cache data should be expired
* @return unknown * @return unknown
*/ */
function wp_cache_add($key, $data, $flag = '', $expire = 0) { function wp_cache_add($key, $data, $group = '', $expire = 0) {
global $wp_object_cache; global $wp_object_cache;
return $wp_object_cache->add($key, $data, $flag, $expire); return $wp_object_cache->add($key, $data, $group, $expire);
} }
/** /**
@ -52,13 +52,13 @@ function wp_cache_close() {
* *
* @param int|string $key The cache ID to increment * @param int|string $key The cache ID to increment
* @param int $offset The amount by which to decrement the item's value. Default is 1. * @param int $offset The amount by which to decrement the item's value. Default is 1.
* @param string $flag The group the key is in. * @param string $group The group the key is in.
* @return false|int False on failure, the item's new value on success. * @return false|int False on failure, the item's new value on success.
*/ */
function wp_cache_decr( $key, $offset = 1, $flag = '' ) { function wp_cache_decr( $key, $offset = 1, $group = '' ) {
global $wp_object_cache; global $wp_object_cache;
return $wp_object_cache->decr( $key, $offset, $flag ); return $wp_object_cache->decr( $key, $offset, $group );
} }
/** /**
@ -68,14 +68,14 @@ function wp_cache_decr( $key, $offset = 1, $flag = '' ) {
* @uses $wp_object_cache Object Cache Class * @uses $wp_object_cache Object Cache Class
* @see WP_Object_Cache::delete() * @see WP_Object_Cache::delete()
* *
* @param int|string $id What the contents in the cache are called * @param int|string $key What the contents in the cache are called
* @param string $flag Where the cache contents are grouped * @param string $group Where the cache contents are grouped
* @return bool True on successful removal, false on failure * @return bool True on successful removal, false on failure
*/ */
function wp_cache_delete($id, $flag = '') { function wp_cache_delete($key, $group = '') {
global $wp_object_cache; global $wp_object_cache;
return $wp_object_cache->delete($id, $flag); return $wp_object_cache->delete($key, $group);
} }
/** /**
@ -100,15 +100,15 @@ function wp_cache_flush() {
* @uses $wp_object_cache Object Cache Class * @uses $wp_object_cache Object Cache Class
* @see WP_Object_Cache::get() * @see WP_Object_Cache::get()
* *
* @param int|string $id What the contents in the cache are called * @param int|string $key What the contents in the cache are called
* @param string $flag Where the cache contents are grouped * @param string $group Where the cache contents are grouped
* @return bool|mixed False on failure to retrieve contents or the cache * @return bool|mixed False on failure to retrieve contents or the cache
* contents on success * contents on success
*/ */
function wp_cache_get($id, $flag = '') { function wp_cache_get($key, $group = '') {
global $wp_object_cache; global $wp_object_cache;
return $wp_object_cache->get($id, $flag); return $wp_object_cache->get($key, $group);
} }
/** /**
@ -120,13 +120,13 @@ function wp_cache_get($id, $flag = '') {
* *
* @param int|string $key The cache ID to increment * @param int|string $key The cache ID to increment
* @param int $offset The amount by which to increment the item's value. Default is 1. * @param int $offset The amount by which to increment the item's value. Default is 1.
* @param string $flag The group the key is in. * @param string $group The group the key is in.
* @return false|int False on failure, the item's new value on success. * @return false|int False on failure, the item's new value on success.
*/ */
function wp_cache_incr( $key, $offset = 1, $flag = '' ) { function wp_cache_incr( $key, $offset = 1, $group = '' ) {
global $wp_object_cache; global $wp_object_cache;
return $wp_object_cache->incr( $key, $offset, $flag ); return $wp_object_cache->incr( $key, $offset, $group );
} }
/** /**
@ -148,14 +148,14 @@ function wp_cache_init() {
* *
* @param int|string $key What to call the contents in the cache * @param int|string $key What to call the contents in the cache
* @param mixed $data The contents to store in the cache * @param mixed $data The contents to store in the cache
* @param string $flag Where to group the cache contents * @param string $group Where to group the cache contents
* @param int $expire When to expire the cache contents * @param int $expire When to expire the cache contents
* @return bool False if cache ID and group already exists, true on success * @return bool False if cache ID and group already exists, true on success
*/ */
function wp_cache_replace($key, $data, $flag = '', $expire = 0) { function wp_cache_replace($key, $data, $group = '', $expire = 0) {
global $wp_object_cache; global $wp_object_cache;
return $wp_object_cache->replace($key, $data, $flag, $expire); return $wp_object_cache->replace($key, $data, $group, $expire);
} }
/** /**
@ -167,14 +167,14 @@ function wp_cache_replace($key, $data, $flag = '', $expire = 0) {
* *
* @param int|string $key What to call the contents in the cache * @param int|string $key What to call the contents in the cache
* @param mixed $data The contents to store in the cache * @param mixed $data The contents to store in the cache
* @param string $flag Where to group the cache contents * @param string $group Where to group the cache contents
* @param int $expire When to expire the cache contents * @param int $expire When to expire the cache contents
* @return bool False if cache ID and group already exists, true on success * @return bool False if cache ID and group already exists, true on success
*/ */
function wp_cache_set($key, $data, $flag = '', $expire = 0) { function wp_cache_set($key, $data, $group = '', $expire = 0) {
global $wp_object_cache; global $wp_object_cache;
return $wp_object_cache->set($key, $data, $flag, $expire); return $wp_object_cache->set($key, $data, $group, $expire);
} }
/** /**
@ -286,20 +286,20 @@ class WP_Object_Cache {
* *
* @since 2.0.0 * @since 2.0.0
* *
* @param int|string $id What to call the contents in the cache * @param int|string $key What to call the contents in the cache
* @param mixed $data The contents to store in the cache * @param mixed $data The contents to store in the cache
* @param string $group Where to group the cache contents * @param string $group Where to group the cache contents
* @param int $expire When to expire the cache contents * @param int $expire When to expire the cache contents
* @return bool False if cache ID and group already exists, true on success * @return bool False if cache ID and group already exists, true on success
*/ */
function add( $id, $data, $group = 'default', $expire = '' ) { function add( $key, $data, $group = 'default', $expire = '' ) {
if ( empty ($group) ) if ( empty ($group) )
$group = 'default'; $group = 'default';
if (false !== $this->get($id, $group)) if (false !== $this->get($key, $group))
return false; return false;
return $this->set($id, $data, $group, $expire); return $this->set($key, $data, $group, $expire);
} }
/** /**
@ -321,26 +321,26 @@ class WP_Object_Cache {
* *
* @since 3.3.0 * @since 3.3.0
* *
* @param int|string $id The cache ID to increment * @param int|string $key The cache ID to increment
* @param int $offset The amount by which to decrement the item's value. Default is 1. * @param int $offset The amount by which to decrement the item's value. Default is 1.
* @param string $flag The group the key is in. * @param string $group The group the key is in.
* @return false|int False on failure, the item's new value on success. * @return false|int False on failure, the item's new value on success.
*/ */
function decr( $id, $offset = 1, $group = 'default' ) { function decr( $key, $offset = 1, $group = 'default' ) {
if ( ! isset( $this->cache[ $group ][ $id ] ) ) if ( ! isset( $this->cache[ $group ][ $key ] ) )
return false; return false;
if ( ! is_numeric( $this->cache[ $group ][ $id ] ) ) if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
$this->cache[ $group ][ $id ] = 0; $this->cache[ $group ][ $key ] = 0;
$offset = (int) $offset; $offset = (int) $offset;
$this->cache[ $group ][ $id ] -= $offset; $this->cache[ $group ][ $key ] -= $offset;
if ( $this->cache[ $group ][ $id ] < 0 ) if ( $this->cache[ $group ][ $key ] < 0 )
$this->cache[ $group ][ $id ] = 0; $this->cache[ $group ][ $key ] = 0;
return $this->cache[ $group ][ $id ]; return $this->cache[ $group ][ $key ];
} }
/** /**
@ -355,21 +355,21 @@ class WP_Object_Cache {
* *
* @since 2.0.0 * @since 2.0.0
* *
* @param int|string $id What the contents in the cache are called * @param int|string $key What the contents in the cache are called
* @param string $group Where the cache contents are grouped * @param string $group Where the cache contents are grouped
* @param bool $force Optional. Whether to force the unsetting of the cache * @param bool $force Optional. Whether to force the unsetting of the cache
* ID in the group * ID in the group
* @return bool False if the contents weren't deleted and true on success * @return bool False if the contents weren't deleted and true on success
*/ */
function delete($id, $group = 'default', $force = false) { function delete($key, $group = 'default', $force = false) {
if (empty ($group)) if (empty ($group))
$group = 'default'; $group = 'default';
if (!$force && false === $this->get($id, $group)) if (!$force && false === $this->get($key, $group))
return false; return false;
unset ($this->cache[$group][$id]); unset ($this->cache[$group][$key]);
$this->non_existent_objects[$group][$id] = true; $this->non_existent_objects[$group][$key] = true;
return true; return true;
} }
@ -401,27 +401,27 @@ class WP_Object_Cache {
* *
* @since 2.0.0 * @since 2.0.0
* *
* @param int|string $id What the contents in the cache are called * @param int|string $key What the contents in the cache are called
* @param string $group Where the cache contents are grouped * @param string $group Where the cache contents are grouped
* @return bool|mixed False on failure to retrieve contents or the cache * @return bool|mixed False on failure to retrieve contents or the cache
* contents on success * contents on success
*/ */
function get($id, $group = 'default') { function get($key, $group = 'default') {
if ( empty ($group) ) if ( empty ($group) )
$group = 'default'; $group = 'default';
if ( isset ($this->cache[$group][$id]) ) { if ( isset ($this->cache[$group][$key]) ) {
$this->cache_hits += 1; $this->cache_hits += 1;
if ( is_object($this->cache[$group][$id]) ) if ( is_object($this->cache[$group][$key]) )
return clone $this->cache[$group][$id]; return clone $this->cache[$group][$key];
else else
return $this->cache[$group][$id]; return $this->cache[$group][$key];
} }
if ( isset ($this->non_existent_objects[$group][$id]) ) if ( isset ($this->non_existent_objects[$group][$key]) )
return false; return false;
$this->non_existent_objects[$group][$id] = true; $this->non_existent_objects[$group][$key] = true;
$this->cache_misses += 1; $this->cache_misses += 1;
return false; return false;
} }
@ -431,26 +431,26 @@ class WP_Object_Cache {
* *
* @since 3.3.0 * @since 3.3.0
* *
* @param int|string $id The cache ID to increment * @param int|string $key The cache ID to increment
* @param int $offset The amount by which to increment the item's value. Default is 1. * @param int $offset The amount by which to increment the item's value. Default is 1.
* @param string $flag The group the key is in. * @param string $group The group the key is in.
* @return false|int False on failure, the item's new value on success. * @return false|int False on failure, the item's new value on success.
*/ */
function incr( $id, $offset = 1, $group = 'default' ) { function incr( $key, $offset = 1, $group = 'default' ) {
if ( ! isset( $this->cache[ $group ][ $id ] ) ) if ( ! isset( $this->cache[ $group ][ $key ] ) )
return false; return false;
if ( ! is_numeric( $this->cache[ $group ][ $id ] ) ) if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
$this->cache[ $group ][ $id ] = 0; $this->cache[ $group ][ $key ] = 0;
$offset = (int) $offset; $offset = (int) $offset;
$this->cache[ $group ][ $id ] += $offset; $this->cache[ $group ][ $key ] += $offset;
if ( $this->cache[ $group ][ $id ] < 0 ) if ( $this->cache[ $group ][ $key ] < 0 )
$this->cache[ $group ][ $id ] = 0; $this->cache[ $group ][ $key ] = 0;
return $this->cache[ $group ][ $id ]; return $this->cache[ $group ][ $key ];
} }
/** /**
@ -459,20 +459,20 @@ class WP_Object_Cache {
* @since 2.0.0 * @since 2.0.0
* @see WP_Object_Cache::set() * @see WP_Object_Cache::set()
* *
* @param int|string $id What to call the contents in the cache * @param int|string $key What to call the contents in the cache
* @param mixed $data The contents to store in the cache * @param mixed $data The contents to store in the cache
* @param string $group Where to group the cache contents * @param string $group Where to group the cache contents
* @param int $expire When to expire the cache contents * @param int $expire When to expire the cache contents
* @return bool False if not exists, true if contents were replaced * @return bool False if not exists, true if contents were replaced
*/ */
function replace($id, $data, $group = 'default', $expire = '') { function replace($key, $data, $group = 'default', $expire = '') {
if (empty ($group)) if (empty ($group))
$group = 'default'; $group = 'default';
if ( false === $this->get($id, $group) ) if ( false === $this->get($key, $group) )
return false; return false;
return $this->set($id, $data, $group, $expire); return $this->set($key, $data, $group, $expire);
} }
/** /**
@ -492,7 +492,7 @@ class WP_Object_Cache {
* Sets the data contents into the cache * Sets the data contents into the cache
* *
* The cache contents is grouped by the $group parameter followed by the * The cache contents is grouped by the $group parameter followed by the
* $id. This allows for duplicate ids in unique groups. Therefore, naming of * $key. This allows for duplicate ids in unique groups. Therefore, naming of
* the group should be used with care and should follow normal function * the group should be used with care and should follow normal function
* naming guidelines outside of core WordPress usage. * naming guidelines outside of core WordPress usage.
* *
@ -502,13 +502,13 @@ class WP_Object_Cache {
* *
* @since 2.0.0 * @since 2.0.0
* *
* @param int|string $id What to call the contents in the cache * @param int|string $key What to call the contents in the cache
* @param mixed $data The contents to store in the cache * @param mixed $data The contents to store in the cache
* @param string $group Where to group the cache contents * @param string $group Where to group the cache contents
* @param int $expire Not Used * @param int $expire Not Used
* @return bool Always returns true * @return bool Always returns true
*/ */
function set($id, $data, $group = 'default', $expire = '') { function set($key, $data, $group = 'default', $expire = '') {
if ( empty ($group) ) if ( empty ($group) )
$group = 'default'; $group = 'default';
@ -518,10 +518,10 @@ class WP_Object_Cache {
if ( is_object($data) ) if ( is_object($data) )
$data = clone $data; $data = clone $data;
$this->cache[$group][$id] = $data; $this->cache[$group][$key] = $data;
if ( isset($this->non_existent_objects[$group][$id]) ) if ( isset($this->non_existent_objects[$group][$key]) )
unset ($this->non_existent_objects[$group][$id]); unset ($this->non_existent_objects[$group][$key]);
return true; return true;
} }