/**
* Object Cache API
*
- * @link http://codex.wordpress.org/Function_Reference/WP_Cache
+ * @link https://codex.wordpress.org/Function_Reference/WP_Cache
*
* @package WordPress
* @subpackage Cache
* Adds data to the cache, if the cache key doesn't already exist.
*
* @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::add()
+ *
+ * @global WP_Object_Cache $wp_object_cache
*
* @param int|string $key The cache key to use for retrieval later
* @param mixed $data The data to add to the cache store
*
* @since 2.0.0
*
- * @return bool Always returns True
+ * @return true Always returns True
*/
function wp_cache_close() {
return true;
* Decrement numeric cache item's value
*
* @since 3.3.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::decr()
+ *
+ * @global WP_Object_Cache $wp_object_cache
*
* @param int|string $key The cache key to increment
* @param int $offset The amount by which to decrement the item's value. Default is 1.
* Removes the cache contents matching key and group.
*
* @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::delete()
+ *
+ * @global WP_Object_Cache $wp_object_cache
*
* @param int|string $key What the contents in the cache are called
* @param string $group Where the cache contents are grouped
* Removes all cache items.
*
* @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::flush()
+ *
+ * @global WP_Object_Cache $wp_object_cache
*
* @return bool False on failure, true on success
*/
* Retrieves the cache contents from the cache by key and group.
*
* @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::get()
+ *
+ * @global WP_Object_Cache $wp_object_cache
*
* @param int|string $key What the contents in the cache are called
* @param string $group Where the cache contents are grouped
* @param bool $force Whether to force an update of the local cache from the persistent cache (default is false)
- * @param &bool $found Whether key was found in the cache. Disambiguates a return of false, a storable value.
+ * @param bool &$found Whether key was found in the cache. Disambiguates a return of false, a storable value.
* @return bool|mixed False on failure to retrieve contents or the cache
- * contents on success
+ * contents on success
*/
function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
global $wp_object_cache;
* Increment numeric cache item's value
*
* @since 3.3.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::incr()
+ *
+ * @global WP_Object_Cache $wp_object_cache
*
* @param int|string $key The cache key to increment
* @param int $offset The amount by which to increment the item's value. Default is 1.
* Sets up Object Cache Global and assigns it.
*
* @since 2.0.0
- * @global WP_Object_Cache $wp_object_cache WordPress Object Cache
+ *
+ * @global WP_Object_Cache $wp_object_cache
*/
function wp_cache_init() {
$GLOBALS['wp_object_cache'] = new WP_Object_Cache();
* Replaces the contents of the cache with new data.
*
* @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::replace()
+ *
+ * @global WP_Object_Cache $wp_object_cache
*
* @param int|string $key What to call the contents in the cache
* @param mixed $data The contents to store in the cache
*
* @since 2.0.0
*
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::set()
+ * @global WP_Object_Cache $wp_object_cache
*
* @param int|string $key What to call the contents in the cache
* @param mixed $data The contents to store in the cache
*
* @since 3.5.0
*
+ * @global WP_Object_Cache $wp_object_cache
+ *
* @param int $blog_id Blog ID
*/
function wp_cache_switch_to_blog( $blog_id ) {
global $wp_object_cache;
- return $wp_object_cache->switch_to_blog( $blog_id );
+ $wp_object_cache->switch_to_blog( $blog_id );
}
/**
*
* @since 2.6.0
*
+ * @global WP_Object_Cache $wp_object_cache
+ *
* @param string|array $groups A group or an array of groups to add
*/
function wp_cache_add_global_groups( $groups ) {
global $wp_object_cache;
- return $wp_object_cache->add_global_groups( $groups );
+ $wp_object_cache->add_global_groups( $groups );
}
/**
*/
function wp_cache_add_non_persistent_groups( $groups ) {
// Default cache doesn't persist so nothing to do here.
- return;
}
/**
*
* @since 2.6.0
* @deprecated 3.5.0
+ *
+ * @global WP_Object_Cache $wp_object_cache
*/
function wp_cache_reset() {
_deprecated_function( __FUNCTION__, '3.5' );
global $wp_object_cache;
- return $wp_object_cache->reset();
+ $wp_object_cache->reset();
}
/**
* @access private
* @since 2.0.0
*/
- var $cache = array ();
+ private $cache = array();
/**
* The amount of times the cache data was already stored in the cache.
* @access private
* @var int
*/
- var $cache_hits = 0;
+ private $cache_hits = 0;
/**
* Amount of times the cache did not have the request in cache
* @access public
* @since 2.0.0
*/
- var $cache_misses = 0;
+ public $cache_misses = 0;
/**
* List of global groups
* @access protected
* @since 3.0.0
*/
- var $global_groups = array();
+ protected $global_groups = array();
/**
* The blog prefix to prepend to keys in non-global groups.
* @access private
* @since 3.5.0
*/
- var $blog_prefix;
+ private $blog_prefix;
+
+ /**
+ * Holds the value of `is_multisite()`
+ *
+ * @var bool
+ * @access private
+ * @since 3.5.0
+ */
+ private $multisite;
+
+ /**
+ * Make private properties readable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to get.
+ * @return mixed Property.
+ */
+ public function __get( $name ) {
+ return $this->$name;
+ }
+
+ /**
+ * Make private properties settable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to set.
+ * @param mixed $value Property value.
+ * @return mixed Newly-set property.
+ */
+ public function __set( $name, $value ) {
+ return $this->$name = $value;
+ }
+
+ /**
+ * Make private properties checkable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to check if set.
+ * @return bool Whether the property is set.
+ */
+ public function __isset( $name ) {
+ return isset( $this->$name );
+ }
+
+ /**
+ * Make private properties un-settable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to unset.
+ */
+ public function __unset( $name ) {
+ unset( $this->$name );
+ }
/**
* Adds data to the cache if it doesn't already exist.
* @param int $expire When to expire the cache contents
* @return bool False if cache key and group already exist, true on success
*/
- function add( $key, $data, $group = 'default', $expire = 0 ) {
+ public function add( $key, $data, $group = 'default', $expire = 0 ) {
if ( wp_suspend_cache_addition() )
return false;
*
* @param array $groups List of groups that are global.
*/
- function add_global_groups( $groups ) {
+ public function add_global_groups( $groups ) {
$groups = (array) $groups;
$groups = array_fill_keys( $groups, true );
* @param string $group The group the key is in.
* @return false|int False on failure, the item's new value on success.
*/
- function decr( $key, $offset = 1, $group = 'default' ) {
+ public function decr( $key, $offset = 1, $group = 'default' ) {
if ( empty( $group ) )
$group = 'default';
*
* @return bool False if the contents weren't deleted and true on success
*/
- function delete( $key, $group = 'default', $deprecated = false ) {
+ public function delete( $key, $group = 'default', $deprecated = false ) {
if ( empty( $group ) )
$group = 'default';
*
* @since 2.0.0
*
- * @return bool Always returns true
+ * @return true Always returns true
*/
- function flush() {
- $this->cache = array ();
+ public function flush() {
+ $this->cache = array();
return true;
}
* @param int|string $key What the contents in the cache are called
* @param string $group Where the cache contents are grouped
* @param string $force Whether to force a refetch rather than relying on the local cache (default is false)
- * @return bool|mixed False on failure to retrieve contents or the cache
- * contents on success
+ * @return false|mixed False on failure to retrieve contents or the cache
+ * contents on success
*/
- function get( $key, $group = 'default', $force = false, &$found = null ) {
+ public function get( $key, $group = 'default', $force = false, &$found = null ) {
if ( empty( $group ) )
$group = 'default';
* @param string $group The group the key is in.
* @return false|int False on failure, the item's new value on success.
*/
- function incr( $key, $offset = 1, $group = 'default' ) {
+ public function incr( $key, $offset = 1, $group = 'default' ) {
if ( empty( $group ) )
$group = 'default';
* @param int $expire When to expire the cache contents
* @return bool False if not exists, true if contents were replaced
*/
- function replace( $key, $data, $group = 'default', $expire = 0 ) {
+ public function replace( $key, $data, $group = 'default', $expire = 0 ) {
if ( empty( $group ) )
$group = 'default';
* @since 3.0.0
* @deprecated 3.5.0
*/
- function reset() {
+ public function reset() {
_deprecated_function( __FUNCTION__, '3.5', 'switch_to_blog()' );
// Clear out non-global caches since the blog ID has changed.
* @param mixed $data The contents to store in the cache
* @param string $group Where to group the cache contents
* @param int $expire Not Used
- * @return bool Always returns true
+ * @return true Always returns true
*/
- function set( $key, $data, $group = 'default', $expire = 0 ) {
+ public function set( $key, $data, $group = 'default', $expire = 0 ) {
if ( empty( $group ) )
$group = 'default';
*
* @since 2.0.0
*/
- function stats() {
+ public function stats() {
echo "<p>";
echo "<strong>Cache Hits:</strong> {$this->cache_hits}<br />";
echo "<strong>Cache Misses:</strong> {$this->cache_misses}<br />";
*
* @param int $blog_id Blog ID
*/
- function switch_to_blog( $blog_id ) {
+ public function switch_to_blog( $blog_id ) {
$blog_id = (int) $blog_id;
$this->blog_prefix = $this->multisite ? $blog_id . ':' : '';
}
* @since 3.4.0
*
* @access protected
+ * @param string $key
+ * @param string $group
+ * @return bool
*/
protected function _exists( $key, $group ) {
return isset( $this->cache[ $group ] ) && ( isset( $this->cache[ $group ][ $key ] ) || array_key_exists( $key, $this->cache[ $group ] ) );
* Sets up object properties; PHP 5 style constructor
*
* @since 2.0.8
- * @return null|WP_Object_Cache If cache is disabled, returns null.
+ *
+ * @global int $blog_id
*/
- function __construct() {
+ public function __construct() {
global $blog_id;
$this->multisite = is_multisite();
*
* @since 2.0.8
*
- * @return bool True value. Won't be used by PHP
+ * @return true True value. Won't be used by PHP
*/
- function __destruct() {
+ public function __destruct() {
return true;
}
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff