X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/11be15bd505d66a91e2c80062190b13e315a04a9..46588ee871246a923d972538dbc93b26f4fda932:/wp-includes/cache.php diff --git a/wp-includes/cache.php b/wp-includes/cache.php index af1c2ada..d75c82c6 100644 --- a/wp-includes/cache.php +++ b/wp-includes/cache.php @@ -2,7 +2,7 @@ /** * 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 @@ -21,10 +21,10 @@ * @param int $expire When the cache data should be expired * @return bool False if cache key and group already exist, true on success */ -function wp_cache_add($key, $data, $group = '', $expire = 0) { +function wp_cache_add( $key, $data, $group = '', $expire = 0 ) { global $wp_object_cache; - return $wp_object_cache->add($key, $data, $group, $expire); + return $wp_object_cache->add( $key, $data, $group, (int) $expire ); } /** @@ -103,7 +103,7 @@ function wp_cache_flush() { * @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 */ @@ -154,16 +154,17 @@ function wp_cache_init() { * @param int $expire When to expire the cache contents * @return bool False if not exists, true if contents were replaced */ -function wp_cache_replace($key, $data, $group = '', $expire = 0) { +function wp_cache_replace( $key, $data, $group = '', $expire = 0 ) { global $wp_object_cache; - return $wp_object_cache->replace($key, $data, $group, $expire); + return $wp_object_cache->replace( $key, $data, $group, (int) $expire ); } /** * Saves the data to the cache. * - * @since 2.0 + * @since 2.0.0 + * * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::set() * @@ -173,10 +174,10 @@ function wp_cache_replace($key, $data, $group = '', $expire = 0) { * @param int $expire When to expire the cache contents * @return bool False on failure, true on success */ -function wp_cache_set($key, $data, $group = '', $expire = 0) { +function wp_cache_set( $key, $data, $group = '', $expire = 0 ) { global $wp_object_cache; - return $wp_object_cache->set($key, $data, $group, $expire); + return $wp_object_cache->set( $key, $data, $group, (int) $expire ); } /** @@ -216,7 +217,6 @@ function wp_cache_add_global_groups( $groups ) { */ function wp_cache_add_non_persistent_groups( $groups ) { // Default cache doesn't persist so nothing to do here. - return; } /** @@ -256,7 +256,7 @@ function wp_cache_reset() { * * @package WordPress * @subpackage Cache - * @since 2.0 + * @since 2.0.0 */ class WP_Object_Cache { @@ -267,7 +267,7 @@ class WP_Object_Cache { * @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. @@ -276,7 +276,7 @@ class WP_Object_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 @@ -285,7 +285,7 @@ class WP_Object_Cache { * @access public * @since 2.0.0 */ - var $cache_misses = 0; + public $cache_misses = 0; /** * List of global groups @@ -294,7 +294,7 @@ class WP_Object_Cache { * @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. @@ -303,7 +303,68 @@ class WP_Object_Cache { * @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. @@ -320,7 +381,7 @@ class WP_Object_Cache { * @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 = '' ) { + public function add( $key, $data, $group = 'default', $expire = 0 ) { if ( wp_suspend_cache_addition() ) return false; @@ -334,7 +395,7 @@ class WP_Object_Cache { if ( $this->_exists( $id, $group ) ) return false; - return $this->set($key, $data, $group, $expire); + return $this->set( $key, $data, $group, (int) $expire ); } /** @@ -344,7 +405,7 @@ class WP_Object_Cache { * * @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 ); @@ -361,7 +422,7 @@ class WP_Object_Cache { * @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'; @@ -387,26 +448,24 @@ class WP_Object_Cache { /** * Remove the contents of the cache key in the group * - * If the cache key does not exist in the group and $force parameter is set - * to false, then nothing will happen. The $force parameter is set to false - * by default. + * If the cache key does not exist in the group, then nothing will happen. * * @since 2.0.0 * * @param int|string $key What the contents in the cache are called * @param string $group Where the cache contents are grouped - * @param bool $force Optional. Whether to force the unsetting of the cache - * key in the group + * @param bool $deprecated Deprecated. + * * @return bool False if the contents weren't deleted and true on success */ - function delete($key, $group = 'default', $force = false) { + public function delete( $key, $group = 'default', $deprecated = false ) { if ( empty( $group ) ) $group = 'default'; if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) $key = $this->blog_prefix . $key; - if ( ! $force && ! $this->_exists( $key, $group ) ) + if ( ! $this->_exists( $key, $group ) ) return false; unset( $this->cache[$group][$key] ); @@ -420,7 +479,7 @@ class WP_Object_Cache { * * @return bool Always returns true */ - function flush() { + public function flush() { $this->cache = array (); return true; @@ -443,7 +502,7 @@ class WP_Object_Cache { * @return bool|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'; @@ -474,7 +533,7 @@ class WP_Object_Cache { * @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'; @@ -509,7 +568,7 @@ class WP_Object_Cache { * @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 = '' ) { + public function replace( $key, $data, $group = 'default', $expire = 0 ) { if ( empty( $group ) ) $group = 'default'; @@ -520,7 +579,7 @@ class WP_Object_Cache { if ( ! $this->_exists( $id, $group ) ) return false; - return $this->set( $key, $data, $group, $expire ); + return $this->set( $key, $data, $group, (int) $expire ); } /** @@ -529,7 +588,7 @@ class WP_Object_Cache { * @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. @@ -559,7 +618,7 @@ class WP_Object_Cache { * @param int $expire Not Used * @return bool Always returns true */ - function set($key, $data, $group = 'default', $expire = '') { + public function set( $key, $data, $group = 'default', $expire = 0 ) { if ( empty( $group ) ) $group = 'default'; @@ -581,7 +640,7 @@ class WP_Object_Cache { * * @since 2.0.0 */ - function stats() { + public function stats() { echo "

"; echo "Cache Hits: {$this->cache_hits}
"; echo "Cache Misses: {$this->cache_misses}
"; @@ -602,7 +661,7 @@ class WP_Object_Cache { * * @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 . ':' : ''; } @@ -613,6 +672,9 @@ class WP_Object_Cache { * @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 ] ) ); @@ -622,9 +684,8 @@ class WP_Object_Cache { * Sets up object properties; PHP 5 style constructor * * @since 2.0.8 - * @return null|WP_Object_Cache If cache is disabled, returns null. */ - function __construct() { + public function __construct() { global $blog_id; $this->multisite = is_multisite(); @@ -647,7 +708,7 @@ class WP_Object_Cache { * * @return bool True value. Won't be used by PHP */ - function __destruct() { + public function __destruct() { return true; } }