<!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>[47197] trunk/src/wp-includes: Coding Standards: Move `WP_Object_Cache` to `wp-includes/class-wp-object-cache.php`.</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 { white-space: pre-line; 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/47197">47197</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/47197","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-02-06 05:51:58 +0000 (Thu, 06 Feb 2020)</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'>Coding Standards: Move `WP_Object_Cache` to `wp-includes/class-wp-object-cache.php`.
This ensures the file containing the `WP_Object_Cache` class conforms to the coding standards.
For backward compatibility, the new file is included from `wp-includes/cache.php`.
Fixes <a href="https://core.trac.wordpress.org/ticket/49373">#49373</a>. See <a href="https://core.trac.wordpress.org/ticket/49222">#49222</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescachephp">trunk/src/wp-includes/cache.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpobjectcachephp">trunk/src/wp-includes/class-wp-object-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 2020-02-05 22:38:11 UTC (rev 47196)
+++ trunk/src/wp-includes/cache.php 2020-02-06 05:51:58 UTC (rev 47197)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,6 +8,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @subpackage Cache
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/** WP_Object_Cache class */
+require_once ABSPATH . WPINC . '/class-wp-object-cache.php';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds data to the cache, if the cache key doesn't already exist.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -270,470 +273,3 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_object_cache->reset();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-/**
- * Core class that implements an object cache.
- *
- * The WordPress Object Cache is used to save on trips to the database. The
- * Object Cache stores all of the cache data to memory and makes the cache
- * contents available by using a key, which is used to name and later retrieve
- * the cache contents.
- *
- * The Object Cache can be replaced by other caching mechanisms by placing files
- * in the wp-content folder which is looked at in wp-settings. If that file
- * exists, then this file will not be included.
- *
- * @since 2.0.0
- */
-class WP_Object_Cache {
-
- /**
- * Holds the cached objects.
- *
- * @since 2.0.0
- * @var array
- */
- private $cache = array();
-
- /**
- * The amount of times the cache data was already stored in the cache.
- *
- * @since 2.5.0
- * @var int
- */
- public $cache_hits = 0;
-
- /**
- * Amount of times the cache did not have the request in cache.
- *
- * @since 2.0.0
- * @var int
- */
- public $cache_misses = 0;
-
- /**
- * List of global cache groups.
- *
- * @since 3.0.0
- * @var array
- */
- protected $global_groups = array();
-
- /**
- * The blog prefix to prepend to keys in non-global groups.
- *
- * @since 3.5.0
- * @var string
- */
- private $blog_prefix;
-
- /**
- * Holds the value of is_multisite().
- *
- * @since 3.5.0
- * @var bool
- */
- private $multisite;
-
- /**
- * Sets up object properties; PHP 5 style constructor.
- *
- * @since 2.0.8
- */
- public function __construct() {
- $this->multisite = is_multisite();
- $this->blog_prefix = $this->multisite ? get_current_blog_id() . ':' : '';
- }
-
- /**
- * Makes private properties readable for backward compatibility.
- *
- * @since 4.0.0
- *
- * @param string $name Property to get.
- * @return mixed Property.
- */
- public function __get( $name ) {
- return $this->$name;
- }
-
- /**
- * Makes private properties settable for backward compatibility.
- *
- * @since 4.0.0
- *
- * @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;
- }
-
- /**
- * Makes private properties checkable for backward compatibility.
- *
- * @since 4.0.0
- *
- * @param string $name Property to check if set.
- * @return bool Whether the property is set.
- */
- public function __isset( $name ) {
- return isset( $this->$name );
- }
-
- /**
- * Makes private properties un-settable for backward compatibility.
- *
- * @since 4.0.0
- *
- * @param string $name Property to unset.
- */
- public function __unset( $name ) {
- unset( $this->$name );
- }
-
- /**
- * Adds data to the cache if it doesn't already exist.
- *
- * @since 2.0.0
- *
- * @uses WP_Object_Cache::_exists() Checks to see if the cache already has data.
- * @uses WP_Object_Cache::set() Sets the data after the checking the cache
- * contents existence.
- *
- * @param int|string $key What to call the contents in the cache.
- * @param mixed $data The contents to store in the cache.
- * @param string $group Optional. Where to group the cache contents. Default 'default'.
- * @param int $expire Optional. When to expire the cache contents. Default 0 (no expiration).
- * @return bool True on success, false if cache key and group already exist.
- */
- public function add( $key, $data, $group = 'default', $expire = 0 ) {
- if ( wp_suspend_cache_addition() ) {
- return false;
- }
-
- if ( empty( $group ) ) {
- $group = 'default';
- }
-
- $id = $key;
- if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
- $id = $this->blog_prefix . $key;
- }
-
- if ( $this->_exists( $id, $group ) ) {
- return false;
- }
-
- return $this->set( $key, $data, $group, (int) $expire );
- }
-
- /**
- * Sets the list of global cache groups.
- *
- * @since 3.0.0
- *
- * @param array $groups List of groups that are global.
- */
- public function add_global_groups( $groups ) {
- $groups = (array) $groups;
-
- $groups = array_fill_keys( $groups, true );
- $this->global_groups = array_merge( $this->global_groups, $groups );
- }
-
- /**
- * Decrements numeric cache item's value.
- *
- * @since 3.3.0
- *
- * @param int|string $key The cache key to decrement.
- * @param int $offset Optional. The amount by which to decrement the item's value. Default 1.
- * @param string $group Optional. The group the key is in. Default 'default'.
- * @return int|false The item's new value on success, false on failure.
- */
- public function decr( $key, $offset = 1, $group = 'default' ) {
- if ( empty( $group ) ) {
- $group = 'default';
- }
-
- if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
- $key = $this->blog_prefix . $key;
- }
-
- if ( ! $this->_exists( $key, $group ) ) {
- return false;
- }
-
- if ( ! is_numeric( $this->cache[ $group ][ $key ] ) ) {
- $this->cache[ $group ][ $key ] = 0;
- }
-
- $offset = (int) $offset;
-
- $this->cache[ $group ][ $key ] -= $offset;
-
- if ( $this->cache[ $group ][ $key ] < 0 ) {
- $this->cache[ $group ][ $key ] = 0;
- }
-
- return $this->cache[ $group ][ $key ];
- }
-
- /**
- * Removes the contents of the cache key in the group.
- *
- * 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 Optional. Where the cache contents are grouped. Default 'default'.
- * @param bool $deprecated Optional. Unused. Default false.
- * @return bool False if the contents weren't deleted and true on success.
- */
- 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 ( ! $this->_exists( $key, $group ) ) {
- return false;
- }
-
- unset( $this->cache[ $group ][ $key ] );
- return true;
- }
-
- /**
- * Clears the object cache of all data.
- *
- * @since 2.0.0
- *
- * @return true Always returns true.
- */
- public function flush() {
- $this->cache = array();
-
- return true;
- }
-
- /**
- * Retrieves the cache contents, if it exists.
- *
- * The contents will be first attempted to be retrieved by searching by the
- * key in the cache group. If the cache is hit (success) then the contents
- * are returned.
- *
- * On failure, the number of cache misses will be incremented.
- *
- * @since 2.0.0
- *
- * @param int|string $key What the contents in the cache are called.
- * @param string $group Optional. Where the cache contents are grouped. Default 'default'.
- * @param bool $force Optional. Unused. Whether to force a refetch rather than relying on the local
- * cache. Default false.
- * @param bool $found Optional. Whether the key was found in the cache (passed by reference).
- * Disambiguates a return of false, a storable value. Default null.
- * @return mixed|false The cache contents on success, false on failure to retrieve contents.
- */
- public function get( $key, $group = 'default', $force = false, &$found = null ) {
- if ( empty( $group ) ) {
- $group = 'default';
- }
-
- if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
- $key = $this->blog_prefix . $key;
- }
-
- if ( $this->_exists( $key, $group ) ) {
- $found = true;
- $this->cache_hits += 1;
- if ( is_object( $this->cache[ $group ][ $key ] ) ) {
- return clone $this->cache[ $group ][ $key ];
- } else {
- return $this->cache[ $group ][ $key ];
- }
- }
-
- $found = false;
- $this->cache_misses += 1;
- return false;
- }
-
- /**
- * Increments numeric cache item's value.
- *
- * @since 3.3.0
- *
- * @param int|string $key The cache key to increment
- * @param int $offset Optional. The amount by which to increment the item's value. Default 1.
- * @param string $group Optional. The group the key is in. Default 'default'.
- * @return int|false The item's new value on success, false on failure.
- */
- public function incr( $key, $offset = 1, $group = 'default' ) {
- if ( empty( $group ) ) {
- $group = 'default';
- }
-
- if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
- $key = $this->blog_prefix . $key;
- }
-
- if ( ! $this->_exists( $key, $group ) ) {
- return false;
- }
-
- if ( ! is_numeric( $this->cache[ $group ][ $key ] ) ) {
- $this->cache[ $group ][ $key ] = 0;
- }
-
- $offset = (int) $offset;
-
- $this->cache[ $group ][ $key ] += $offset;
-
- if ( $this->cache[ $group ][ $key ] < 0 ) {
- $this->cache[ $group ][ $key ] = 0;
- }
-
- return $this->cache[ $group ][ $key ];
- }
-
- /**
- * Replaces the contents in the cache, if contents already exist.
- *
- * @since 2.0.0
- *
- * @see WP_Object_Cache::set()
- *
- * @param int|string $key What to call the contents in the cache.
- * @param mixed $data The contents to store in the cache.
- * @param string $group Optional. Where to group the cache contents. Default 'default'.
- * @param int $expire Optional. When to expire the cache contents. Default 0 (no expiration).
- * @return bool False if not exists, true if contents were replaced.
- */
- public function replace( $key, $data, $group = 'default', $expire = 0 ) {
- if ( empty( $group ) ) {
- $group = 'default';
- }
-
- $id = $key;
- if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
- $id = $this->blog_prefix . $key;
- }
-
- if ( ! $this->_exists( $id, $group ) ) {
- return false;
- }
-
- return $this->set( $key, $data, $group, (int) $expire );
- }
-
- /**
- * Resets cache keys.
- *
- * @since 3.0.0
- *
- * @deprecated 3.5.0 Use switch_to_blog()
- * @see switch_to_blog()
- */
- public function reset() {
- _deprecated_function( __FUNCTION__, '3.5.0', 'switch_to_blog()' );
-
- // Clear out non-global caches since the blog ID has changed.
- foreach ( array_keys( $this->cache ) as $group ) {
- if ( ! isset( $this->global_groups[ $group ] ) ) {
- unset( $this->cache[ $group ] );
- }
- }
- }
-
- /**
- * Sets the data contents into the cache.
- *
- * The cache contents are grouped by the $group parameter followed by the
- * $key. This allows for duplicate ids in unique groups. Therefore, naming of
- * the group should be used with care and should follow normal function
- * naming guidelines outside of core WordPress usage.
- *
- * The $expire parameter is not used, because the cache will automatically
- * expire for each time a page is accessed and PHP finishes. The method is
- * more for cache plugins which use files.
- *
- * @since 2.0.0
- *
- * @param int|string $key What to call the contents in the cache.
- * @param mixed $data The contents to store in the cache.
- * @param string $group Optional. Where to group the cache contents. Default 'default'.
- * @param int $expire Not Used.
- * @return true Always returns true.
- */
- public function set( $key, $data, $group = 'default', $expire = 0 ) {
- if ( empty( $group ) ) {
- $group = 'default';
- }
-
- if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
- $key = $this->blog_prefix . $key;
- }
-
- if ( is_object( $data ) ) {
- $data = clone $data;
- }
-
- $this->cache[ $group ][ $key ] = $data;
- return true;
- }
-
- /**
- * Echoes the stats of the caching.
- *
- * Gives the cache hits, and cache misses. Also prints every cached group,
- * key and the data.
- *
- * @since 2.0.0
- */
- public function stats() {
- echo '<p>';
- echo "<strong>Cache Hits:</strong> {$this->cache_hits}<br />";
- echo "<strong>Cache Misses:</strong> {$this->cache_misses}<br />";
- echo '</p>';
- echo '<ul>';
- foreach ( $this->cache as $group => $cache ) {
- echo "<li><strong>Group:</strong> $group - ( " . number_format( strlen( serialize( $cache ) ) / KB_IN_BYTES, 2 ) . 'k )</li>';
- }
- echo '</ul>';
- }
-
- /**
- * Switches the internal blog ID.
- *
- * This changes the blog ID used to create keys in blog specific groups.
- *
- * @since 3.5.0
- *
- * @param int $blog_id Blog ID.
- */
- public function switch_to_blog( $blog_id ) {
- $blog_id = (int) $blog_id;
- $this->blog_prefix = $this->multisite ? $blog_id . ':' : '';
- }
-
- /**
- * Serves as a utility function to determine whether a key exists in the cache.
- *
- * @since 3.4.0
- *
- * @param int|string $key Cache key to check for existence.
- * @param string $group Cache group for the key existence check.
- * @return bool Whether the key exists in the cache for the given group.
- */
- protected function _exists( $key, $group ) {
- return isset( $this->cache[ $group ] ) && ( isset( $this->cache[ $group ][ $key ] ) || array_key_exists( $key, $this->cache[ $group ] ) );
- }
-}
</del></span></pre></div>
<a id="trunksrcwpincludesclasswpobjectcachephpfromrev47196trunksrcwpincludescachephp"></a>
<div class="copfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Copied: trunk/src/wp-includes/class-wp-object-cache.php (from rev 47196, 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/class-wp-object-cache.php (rev 0)
+++ trunk/src/wp-includes/class-wp-object-cache.php 2020-02-06 05:51:58 UTC (rev 47197)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,475 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Object Cache API: WP_Object_Cache class
+ *
+ * @package WordPress
+ * @subpackage Cache
+ * @since 5.4.0
+ */
+
+/**
+ * Core class that implements an object cache.
+ *
+ * The WordPress Object Cache is used to save on trips to the database. The
+ * Object Cache stores all of the cache data to memory and makes the cache
+ * contents available by using a key, which is used to name and later retrieve
+ * the cache contents.
+ *
+ * The Object Cache can be replaced by other caching mechanisms by placing files
+ * in the wp-content folder which is looked at in wp-settings. If that file
+ * exists, then this file will not be included.
+ *
+ * @since 2.0.0
+ */
+class WP_Object_Cache {
+
+ /**
+ * Holds the cached objects.
+ *
+ * @since 2.0.0
+ * @var array
+ */
+ private $cache = array();
+
+ /**
+ * The amount of times the cache data was already stored in the cache.
+ *
+ * @since 2.5.0
+ * @var int
+ */
+ public $cache_hits = 0;
+
+ /**
+ * Amount of times the cache did not have the request in cache.
+ *
+ * @since 2.0.0
+ * @var int
+ */
+ public $cache_misses = 0;
+
+ /**
+ * List of global cache groups.
+ *
+ * @since 3.0.0
+ * @var array
+ */
+ protected $global_groups = array();
+
+ /**
+ * The blog prefix to prepend to keys in non-global groups.
+ *
+ * @since 3.5.0
+ * @var string
+ */
+ private $blog_prefix;
+
+ /**
+ * Holds the value of is_multisite().
+ *
+ * @since 3.5.0
+ * @var bool
+ */
+ private $multisite;
+
+ /**
+ * Sets up object properties; PHP 5 style constructor.
+ *
+ * @since 2.0.8
+ */
+ public function __construct() {
+ $this->multisite = is_multisite();
+ $this->blog_prefix = $this->multisite ? get_current_blog_id() . ':' : '';
+ }
+
+ /**
+ * Makes private properties readable for backward compatibility.
+ *
+ * @since 4.0.0
+ *
+ * @param string $name Property to get.
+ * @return mixed Property.
+ */
+ public function __get( $name ) {
+ return $this->$name;
+ }
+
+ /**
+ * Makes private properties settable for backward compatibility.
+ *
+ * @since 4.0.0
+ *
+ * @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;
+ }
+
+ /**
+ * Makes private properties checkable for backward compatibility.
+ *
+ * @since 4.0.0
+ *
+ * @param string $name Property to check if set.
+ * @return bool Whether the property is set.
+ */
+ public function __isset( $name ) {
+ return isset( $this->$name );
+ }
+
+ /**
+ * Makes private properties un-settable for backward compatibility.
+ *
+ * @since 4.0.0
+ *
+ * @param string $name Property to unset.
+ */
+ public function __unset( $name ) {
+ unset( $this->$name );
+ }
+
+ /**
+ * Adds data to the cache if it doesn't already exist.
+ *
+ * @since 2.0.0
+ *
+ * @uses WP_Object_Cache::_exists() Checks to see if the cache already has data.
+ * @uses WP_Object_Cache::set() Sets the data after the checking the cache
+ * contents existence.
+ *
+ * @param int|string $key What to call the contents in the cache.
+ * @param mixed $data The contents to store in the cache.
+ * @param string $group Optional. Where to group the cache contents. Default 'default'.
+ * @param int $expire Optional. When to expire the cache contents. Default 0 (no expiration).
+ * @return bool True on success, false if cache key and group already exist.
+ */
+ public function add( $key, $data, $group = 'default', $expire = 0 ) {
+ if ( wp_suspend_cache_addition() ) {
+ return false;
+ }
+
+ if ( empty( $group ) ) {
+ $group = 'default';
+ }
+
+ $id = $key;
+ if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
+ $id = $this->blog_prefix . $key;
+ }
+
+ if ( $this->_exists( $id, $group ) ) {
+ return false;
+ }
+
+ return $this->set( $key, $data, $group, (int) $expire );
+ }
+
+ /**
+ * Sets the list of global cache groups.
+ *
+ * @since 3.0.0
+ *
+ * @param array $groups List of groups that are global.
+ */
+ public function add_global_groups( $groups ) {
+ $groups = (array) $groups;
+
+ $groups = array_fill_keys( $groups, true );
+ $this->global_groups = array_merge( $this->global_groups, $groups );
+ }
+
+ /**
+ * Decrements numeric cache item's value.
+ *
+ * @since 3.3.0
+ *
+ * @param int|string $key The cache key to decrement.
+ * @param int $offset Optional. The amount by which to decrement the item's value. Default 1.
+ * @param string $group Optional. The group the key is in. Default 'default'.
+ * @return int|false The item's new value on success, false on failure.
+ */
+ public function decr( $key, $offset = 1, $group = 'default' ) {
+ if ( empty( $group ) ) {
+ $group = 'default';
+ }
+
+ if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
+ $key = $this->blog_prefix . $key;
+ }
+
+ if ( ! $this->_exists( $key, $group ) ) {
+ return false;
+ }
+
+ if ( ! is_numeric( $this->cache[ $group ][ $key ] ) ) {
+ $this->cache[ $group ][ $key ] = 0;
+ }
+
+ $offset = (int) $offset;
+
+ $this->cache[ $group ][ $key ] -= $offset;
+
+ if ( $this->cache[ $group ][ $key ] < 0 ) {
+ $this->cache[ $group ][ $key ] = 0;
+ }
+
+ return $this->cache[ $group ][ $key ];
+ }
+
+ /**
+ * Removes the contents of the cache key in the group.
+ *
+ * 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 Optional. Where the cache contents are grouped. Default 'default'.
+ * @param bool $deprecated Optional. Unused. Default false.
+ * @return bool False if the contents weren't deleted and true on success.
+ */
+ 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 ( ! $this->_exists( $key, $group ) ) {
+ return false;
+ }
+
+ unset( $this->cache[ $group ][ $key ] );
+ return true;
+ }
+
+ /**
+ * Clears the object cache of all data.
+ *
+ * @since 2.0.0
+ *
+ * @return true Always returns true.
+ */
+ public function flush() {
+ $this->cache = array();
+
+ return true;
+ }
+
+ /**
+ * Retrieves the cache contents, if it exists.
+ *
+ * The contents will be first attempted to be retrieved by searching by the
+ * key in the cache group. If the cache is hit (success) then the contents
+ * are returned.
+ *
+ * On failure, the number of cache misses will be incremented.
+ *
+ * @since 2.0.0
+ *
+ * @param int|string $key What the contents in the cache are called.
+ * @param string $group Optional. Where the cache contents are grouped. Default 'default'.
+ * @param bool $force Optional. Unused. Whether to force a refetch rather than relying on the local
+ * cache. Default false.
+ * @param bool $found Optional. Whether the key was found in the cache (passed by reference).
+ * Disambiguates a return of false, a storable value. Default null.
+ * @return mixed|false The cache contents on success, false on failure to retrieve contents.
+ */
+ public function get( $key, $group = 'default', $force = false, &$found = null ) {
+ if ( empty( $group ) ) {
+ $group = 'default';
+ }
+
+ if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
+ $key = $this->blog_prefix . $key;
+ }
+
+ if ( $this->_exists( $key, $group ) ) {
+ $found = true;
+ $this->cache_hits += 1;
+ if ( is_object( $this->cache[ $group ][ $key ] ) ) {
+ return clone $this->cache[ $group ][ $key ];
+ } else {
+ return $this->cache[ $group ][ $key ];
+ }
+ }
+
+ $found = false;
+ $this->cache_misses += 1;
+ return false;
+ }
+
+ /**
+ * Increments numeric cache item's value.
+ *
+ * @since 3.3.0
+ *
+ * @param int|string $key The cache key to increment
+ * @param int $offset Optional. The amount by which to increment the item's value. Default 1.
+ * @param string $group Optional. The group the key is in. Default 'default'.
+ * @return int|false The item's new value on success, false on failure.
+ */
+ public function incr( $key, $offset = 1, $group = 'default' ) {
+ if ( empty( $group ) ) {
+ $group = 'default';
+ }
+
+ if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
+ $key = $this->blog_prefix . $key;
+ }
+
+ if ( ! $this->_exists( $key, $group ) ) {
+ return false;
+ }
+
+ if ( ! is_numeric( $this->cache[ $group ][ $key ] ) ) {
+ $this->cache[ $group ][ $key ] = 0;
+ }
+
+ $offset = (int) $offset;
+
+ $this->cache[ $group ][ $key ] += $offset;
+
+ if ( $this->cache[ $group ][ $key ] < 0 ) {
+ $this->cache[ $group ][ $key ] = 0;
+ }
+
+ return $this->cache[ $group ][ $key ];
+ }
+
+ /**
+ * Replaces the contents in the cache, if contents already exist.
+ *
+ * @since 2.0.0
+ *
+ * @see WP_Object_Cache::set()
+ *
+ * @param int|string $key What to call the contents in the cache.
+ * @param mixed $data The contents to store in the cache.
+ * @param string $group Optional. Where to group the cache contents. Default 'default'.
+ * @param int $expire Optional. When to expire the cache contents. Default 0 (no expiration).
+ * @return bool False if not exists, true if contents were replaced.
+ */
+ public function replace( $key, $data, $group = 'default', $expire = 0 ) {
+ if ( empty( $group ) ) {
+ $group = 'default';
+ }
+
+ $id = $key;
+ if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
+ $id = $this->blog_prefix . $key;
+ }
+
+ if ( ! $this->_exists( $id, $group ) ) {
+ return false;
+ }
+
+ return $this->set( $key, $data, $group, (int) $expire );
+ }
+
+ /**
+ * Resets cache keys.
+ *
+ * @since 3.0.0
+ *
+ * @deprecated 3.5.0 Use switch_to_blog()
+ * @see switch_to_blog()
+ */
+ public function reset() {
+ _deprecated_function( __FUNCTION__, '3.5.0', 'switch_to_blog()' );
+
+ // Clear out non-global caches since the blog ID has changed.
+ foreach ( array_keys( $this->cache ) as $group ) {
+ if ( ! isset( $this->global_groups[ $group ] ) ) {
+ unset( $this->cache[ $group ] );
+ }
+ }
+ }
+
+ /**
+ * Sets the data contents into the cache.
+ *
+ * The cache contents are grouped by the $group parameter followed by the
+ * $key. This allows for duplicate ids in unique groups. Therefore, naming of
+ * the group should be used with care and should follow normal function
+ * naming guidelines outside of core WordPress usage.
+ *
+ * The $expire parameter is not used, because the cache will automatically
+ * expire for each time a page is accessed and PHP finishes. The method is
+ * more for cache plugins which use files.
+ *
+ * @since 2.0.0
+ *
+ * @param int|string $key What to call the contents in the cache.
+ * @param mixed $data The contents to store in the cache.
+ * @param string $group Optional. Where to group the cache contents. Default 'default'.
+ * @param int $expire Not Used.
+ * @return true Always returns true.
+ */
+ public function set( $key, $data, $group = 'default', $expire = 0 ) {
+ if ( empty( $group ) ) {
+ $group = 'default';
+ }
+
+ if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {
+ $key = $this->blog_prefix . $key;
+ }
+
+ if ( is_object( $data ) ) {
+ $data = clone $data;
+ }
+
+ $this->cache[ $group ][ $key ] = $data;
+ return true;
+ }
+
+ /**
+ * Echoes the stats of the caching.
+ *
+ * Gives the cache hits, and cache misses. Also prints every cached group,
+ * key and the data.
+ *
+ * @since 2.0.0
+ */
+ public function stats() {
+ echo '<p>';
+ echo "<strong>Cache Hits:</strong> {$this->cache_hits}<br />";
+ echo "<strong>Cache Misses:</strong> {$this->cache_misses}<br />";
+ echo '</p>';
+ echo '<ul>';
+ foreach ( $this->cache as $group => $cache ) {
+ echo "<li><strong>Group:</strong> $group - ( " . number_format( strlen( serialize( $cache ) ) / KB_IN_BYTES, 2 ) . 'k )</li>';
+ }
+ echo '</ul>';
+ }
+
+ /**
+ * Switches the internal blog ID.
+ *
+ * This changes the blog ID used to create keys in blog specific groups.
+ *
+ * @since 3.5.0
+ *
+ * @param int $blog_id Blog ID.
+ */
+ public function switch_to_blog( $blog_id ) {
+ $blog_id = (int) $blog_id;
+ $this->blog_prefix = $this->multisite ? $blog_id . ':' : '';
+ }
+
+ /**
+ * Serves as a utility function to determine whether a key exists in the cache.
+ *
+ * @since 3.4.0
+ *
+ * @param int|string $key Cache key to check for existence.
+ * @param string $group Cache group for the key existence check.
+ * @return bool Whether the key exists in the cache for the given group.
+ */
+ protected function _exists( $key, $group ) {
+ return isset( $this->cache[ $group ] ) && ( isset( $this->cache[ $group ][ $key ] ) || array_key_exists( $key, $this->cache[ $group ] ) );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>