WordPress 4.2
[autoinstalls/wordpress.git] / wp-includes / cache.php
1 <?php
2 /**
3  * Object Cache API
4  *
5  * @link https://codex.wordpress.org/Function_Reference/WP_Cache
6  *
7  * @package WordPress
8  * @subpackage Cache
9  */
10
11 /**
12  * Adds data to the cache, if the cache key doesn't already exist.
13  *
14  * @since 2.0.0
15  * @uses $wp_object_cache Object Cache Class
16  * @see WP_Object_Cache::add()
17  *
18  * @param int|string $key The cache key to use for retrieval later
19  * @param mixed $data The data to add to the cache store
20  * @param string $group The group to add the cache to
21  * @param int $expire When the cache data should be expired
22  * @return bool False if cache key and group already exist, true on success
23  */
24 function wp_cache_add( $key, $data, $group = '', $expire = 0 ) {
25         global $wp_object_cache;
26
27         return $wp_object_cache->add( $key, $data, $group, (int) $expire );
28 }
29
30 /**
31  * Closes the cache.
32  *
33  * This function has ceased to do anything since WordPress 2.5. The
34  * functionality was removed along with the rest of the persistent cache. This
35  * does not mean that plugins can't implement this function when they need to
36  * make sure that the cache is cleaned up after WordPress no longer needs it.
37  *
38  * @since 2.0.0
39  *
40  * @return bool Always returns True
41  */
42 function wp_cache_close() {
43         return true;
44 }
45
46 /**
47  * Decrement numeric cache item's value
48  *
49  * @since 3.3.0
50  * @uses $wp_object_cache Object Cache Class
51  * @see WP_Object_Cache::decr()
52  *
53  * @param int|string $key The cache key to increment
54  * @param int $offset The amount by which to decrement the item's value. Default is 1.
55  * @param string $group The group the key is in.
56  * @return false|int False on failure, the item's new value on success.
57  */
58 function wp_cache_decr( $key, $offset = 1, $group = '' ) {
59         global $wp_object_cache;
60
61         return $wp_object_cache->decr( $key, $offset, $group );
62 }
63
64 /**
65  * Removes the cache contents matching key and group.
66  *
67  * @since 2.0.0
68  * @uses $wp_object_cache Object Cache Class
69  * @see WP_Object_Cache::delete()
70  *
71  * @param int|string $key What the contents in the cache are called
72  * @param string $group Where the cache contents are grouped
73  * @return bool True on successful removal, false on failure
74  */
75 function wp_cache_delete($key, $group = '') {
76         global $wp_object_cache;
77
78         return $wp_object_cache->delete($key, $group);
79 }
80
81 /**
82  * Removes all cache items.
83  *
84  * @since 2.0.0
85  * @uses $wp_object_cache Object Cache Class
86  * @see WP_Object_Cache::flush()
87  *
88  * @return bool False on failure, true on success
89  */
90 function wp_cache_flush() {
91         global $wp_object_cache;
92
93         return $wp_object_cache->flush();
94 }
95
96 /**
97  * Retrieves the cache contents from the cache by key and group.
98  *
99  * @since 2.0.0
100  * @uses $wp_object_cache Object Cache Class
101  * @see WP_Object_Cache::get()
102  *
103  * @param int|string $key What the contents in the cache are called
104  * @param string $group Where the cache contents are grouped
105  * @param bool $force Whether to force an update of the local cache from the persistent cache (default is false)
106  * @param bool &$found Whether key was found in the cache. Disambiguates a return of false, a storable value.
107  * @return bool|mixed False on failure to retrieve contents or the cache
108  *              contents on success
109  */
110 function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
111         global $wp_object_cache;
112
113         return $wp_object_cache->get( $key, $group, $force, $found );
114 }
115
116 /**
117  * Increment numeric cache item's value
118  *
119  * @since 3.3.0
120  * @uses $wp_object_cache Object Cache Class
121  * @see WP_Object_Cache::incr()
122  *
123  * @param int|string $key The cache key to increment
124  * @param int $offset The amount by which to increment the item's value. Default is 1.
125  * @param string $group The group the key is in.
126  * @return false|int False on failure, the item's new value on success.
127  */
128 function wp_cache_incr( $key, $offset = 1, $group = '' ) {
129         global $wp_object_cache;
130
131         return $wp_object_cache->incr( $key, $offset, $group );
132 }
133
134 /**
135  * Sets up Object Cache Global and assigns it.
136  *
137  * @since 2.0.0
138  * @global WP_Object_Cache $wp_object_cache WordPress Object Cache
139  */
140 function wp_cache_init() {
141         $GLOBALS['wp_object_cache'] = new WP_Object_Cache();
142 }
143
144 /**
145  * Replaces the contents of the cache with new data.
146  *
147  * @since 2.0.0
148  * @uses $wp_object_cache Object Cache Class
149  * @see WP_Object_Cache::replace()
150  *
151  * @param int|string $key What to call the contents in the cache
152  * @param mixed $data The contents to store in the cache
153  * @param string $group Where to group the cache contents
154  * @param int $expire When to expire the cache contents
155  * @return bool False if not exists, true if contents were replaced
156  */
157 function wp_cache_replace( $key, $data, $group = '', $expire = 0 ) {
158         global $wp_object_cache;
159
160         return $wp_object_cache->replace( $key, $data, $group, (int) $expire );
161 }
162
163 /**
164  * Saves the data to the cache.
165  *
166  * @since 2.0.0
167  *
168  * @uses $wp_object_cache Object Cache Class
169  * @see WP_Object_Cache::set()
170  *
171  * @param int|string $key What to call the contents in the cache
172  * @param mixed $data The contents to store in the cache
173  * @param string $group Where to group the cache contents
174  * @param int $expire When to expire the cache contents
175  * @return bool False on failure, true on success
176  */
177 function wp_cache_set( $key, $data, $group = '', $expire = 0 ) {
178         global $wp_object_cache;
179
180         return $wp_object_cache->set( $key, $data, $group, (int) $expire );
181 }
182
183 /**
184  * Switch the interal blog id.
185  *
186  * This changes the blog id used to create keys in blog specific groups.
187  *
188  * @since 3.5.0
189  *
190  * @param int $blog_id Blog ID
191  */
192 function wp_cache_switch_to_blog( $blog_id ) {
193         global $wp_object_cache;
194
195         return $wp_object_cache->switch_to_blog( $blog_id );
196 }
197
198 /**
199  * Adds a group or set of groups to the list of global groups.
200  *
201  * @since 2.6.0
202  *
203  * @param string|array $groups A group or an array of groups to add
204  */
205 function wp_cache_add_global_groups( $groups ) {
206         global $wp_object_cache;
207
208         return $wp_object_cache->add_global_groups( $groups );
209 }
210
211 /**
212  * Adds a group or set of groups to the list of non-persistent groups.
213  *
214  * @since 2.6.0
215  *
216  * @param string|array $groups A group or an array of groups to add
217  */
218 function wp_cache_add_non_persistent_groups( $groups ) {
219         // Default cache doesn't persist so nothing to do here.
220 }
221
222 /**
223  * Reset internal cache keys and structures. If the cache backend uses global
224  * blog or site IDs as part of its cache keys, this function instructs the
225  * backend to reset those keys and perform any cleanup since blog or site IDs
226  * have changed since cache init.
227  *
228  * This function is deprecated. Use wp_cache_switch_to_blog() instead of this
229  * function when preparing the cache for a blog switch. For clearing the cache
230  * during unit tests, consider using wp_cache_init(). wp_cache_init() is not
231  * recommended outside of unit tests as the performance penality for using it is
232  * high.
233  *
234  * @since 2.6.0
235  * @deprecated 3.5.0
236  */
237 function wp_cache_reset() {
238         _deprecated_function( __FUNCTION__, '3.5' );
239
240         global $wp_object_cache;
241
242         return $wp_object_cache->reset();
243 }
244
245 /**
246  * WordPress Object Cache
247  *
248  * The WordPress Object Cache is used to save on trips to the database. The
249  * Object Cache stores all of the cache data to memory and makes the cache
250  * contents available by using a key, which is used to name and later retrieve
251  * the cache contents.
252  *
253  * The Object Cache can be replaced by other caching mechanisms by placing files
254  * in the wp-content folder which is looked at in wp-settings. If that file
255  * exists, then this file will not be included.
256  *
257  * @package WordPress
258  * @subpackage Cache
259  * @since 2.0.0
260  */
261 class WP_Object_Cache {
262
263         /**
264          * Holds the cached objects
265          *
266          * @var array
267          * @access private
268          * @since 2.0.0
269          */
270         private $cache = array();
271
272         /**
273          * The amount of times the cache data was already stored in the cache.
274          *
275          * @since 2.5.0
276          * @access private
277          * @var int
278          */
279         private $cache_hits = 0;
280
281         /**
282          * Amount of times the cache did not have the request in cache
283          *
284          * @var int
285          * @access public
286          * @since 2.0.0
287          */
288         public $cache_misses = 0;
289
290         /**
291          * List of global groups
292          *
293          * @var array
294          * @access protected
295          * @since 3.0.0
296          */
297         protected $global_groups = array();
298
299         /**
300          * The blog prefix to prepend to keys in non-global groups.
301          *
302          * @var int
303          * @access private
304          * @since 3.5.0
305          */
306         private $blog_prefix;
307
308         /**
309          * Holds the value of `is_multisite()`
310          *
311          * @var bool
312          * @access private
313          * @since 3.5.0
314          */
315         private $multisite;
316
317         /**
318          * Make private properties readable for backwards compatibility.
319          *
320          * @since 4.0.0
321          * @access public
322          *
323          * @param string $name Property to get.
324          * @return mixed Property.
325          */
326         public function __get( $name ) {
327                 return $this->$name;
328         }
329
330         /**
331          * Make private properties settable for backwards compatibility.
332          *
333          * @since 4.0.0
334          * @access public
335          *
336          * @param string $name  Property to set.
337          * @param mixed  $value Property value.
338          * @return mixed Newly-set property.
339          */
340         public function __set( $name, $value ) {
341                 return $this->$name = $value;
342         }
343
344         /**
345          * Make private properties checkable for backwards compatibility.
346          *
347          * @since 4.0.0
348          * @access public
349          *
350          * @param string $name Property to check if set.
351          * @return bool Whether the property is set.
352          */
353         public function __isset( $name ) {
354                 return isset( $this->$name );
355         }
356
357         /**
358          * Make private properties un-settable for backwards compatibility.
359          *
360          * @since 4.0.0
361          * @access public
362          *
363          * @param string $name Property to unset.
364          */
365         public function __unset( $name ) {
366                 unset( $this->$name );
367         }
368
369         /**
370          * Adds data to the cache if it doesn't already exist.
371          *
372          * @uses WP_Object_Cache::_exists Checks to see if the cache already has data.
373          * @uses WP_Object_Cache::set Sets the data after the checking the cache
374          *              contents existence.
375          *
376          * @since 2.0.0
377          *
378          * @param int|string $key What to call the contents in the cache
379          * @param mixed $data The contents to store in the cache
380          * @param string $group Where to group the cache contents
381          * @param int $expire When to expire the cache contents
382          * @return bool False if cache key and group already exist, true on success
383          */
384         public function add( $key, $data, $group = 'default', $expire = 0 ) {
385                 if ( wp_suspend_cache_addition() )
386                         return false;
387
388                 if ( empty( $group ) )
389                         $group = 'default';
390
391                 $id = $key;
392                 if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
393                         $id = $this->blog_prefix . $key;
394
395                 if ( $this->_exists( $id, $group ) )
396                         return false;
397
398                 return $this->set( $key, $data, $group, (int) $expire );
399         }
400
401         /**
402          * Sets the list of global groups.
403          *
404          * @since 3.0.0
405          *
406          * @param array $groups List of groups that are global.
407          */
408         public function add_global_groups( $groups ) {
409                 $groups = (array) $groups;
410
411                 $groups = array_fill_keys( $groups, true );
412                 $this->global_groups = array_merge( $this->global_groups, $groups );
413         }
414
415         /**
416          * Decrement numeric cache item's value
417          *
418          * @since 3.3.0
419          *
420          * @param int|string $key The cache key to increment
421          * @param int $offset The amount by which to decrement the item's value. Default is 1.
422          * @param string $group The group the key is in.
423          * @return false|int False on failure, the item's new value on success.
424          */
425         public function decr( $key, $offset = 1, $group = 'default' ) {
426                 if ( empty( $group ) )
427                         $group = 'default';
428
429                 if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
430                         $key = $this->blog_prefix . $key;
431
432                 if ( ! $this->_exists( $key, $group ) )
433                         return false;
434
435                 if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
436                         $this->cache[ $group ][ $key ] = 0;
437
438                 $offset = (int) $offset;
439
440                 $this->cache[ $group ][ $key ] -= $offset;
441
442                 if ( $this->cache[ $group ][ $key ] < 0 )
443                         $this->cache[ $group ][ $key ] = 0;
444
445                 return $this->cache[ $group ][ $key ];
446         }
447
448         /**
449          * Remove the contents of the cache key in the group
450          *
451          * If the cache key does not exist in the group, then nothing will happen.
452          *
453          * @since 2.0.0
454          *
455          * @param int|string $key What the contents in the cache are called
456          * @param string $group Where the cache contents are grouped
457          * @param bool $deprecated Deprecated.
458          *
459          * @return bool False if the contents weren't deleted and true on success
460          */
461         public function delete( $key, $group = 'default', $deprecated = false ) {
462                 if ( empty( $group ) )
463                         $group = 'default';
464
465                 if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
466                         $key = $this->blog_prefix . $key;
467
468                 if ( ! $this->_exists( $key, $group ) )
469                         return false;
470
471                 unset( $this->cache[$group][$key] );
472                 return true;
473         }
474
475         /**
476          * Clears the object cache of all data
477          *
478          * @since 2.0.0
479          *
480          * @return bool Always returns true
481          */
482         public function flush() {
483                 $this->cache = array ();
484
485                 return true;
486         }
487
488         /**
489          * Retrieves the cache contents, if it exists
490          *
491          * The contents will be first attempted to be retrieved by searching by the
492          * key in the cache group. If the cache is hit (success) then the contents
493          * are returned.
494          *
495          * On failure, the number of cache misses will be incremented.
496          *
497          * @since 2.0.0
498          *
499          * @param int|string $key What the contents in the cache are called
500          * @param string $group Where the cache contents are grouped
501          * @param string $force Whether to force a refetch rather than relying on the local cache (default is false)
502          * @return bool|mixed False on failure to retrieve contents or the cache
503          *              contents on success
504          */
505         public function get( $key, $group = 'default', $force = false, &$found = null ) {
506                 if ( empty( $group ) )
507                         $group = 'default';
508
509                 if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
510                         $key = $this->blog_prefix . $key;
511
512                 if ( $this->_exists( $key, $group ) ) {
513                         $found = true;
514                         $this->cache_hits += 1;
515                         if ( is_object($this->cache[$group][$key]) )
516                                 return clone $this->cache[$group][$key];
517                         else
518                                 return $this->cache[$group][$key];
519                 }
520
521                 $found = false;
522                 $this->cache_misses += 1;
523                 return false;
524         }
525
526         /**
527          * Increment numeric cache item's value
528          *
529          * @since 3.3.0
530          *
531          * @param int|string $key The cache key to increment
532          * @param int $offset The amount by which to increment the item's value. Default is 1.
533          * @param string $group The group the key is in.
534          * @return false|int False on failure, the item's new value on success.
535          */
536         public function incr( $key, $offset = 1, $group = 'default' ) {
537                 if ( empty( $group ) )
538                         $group = 'default';
539
540                 if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
541                         $key = $this->blog_prefix . $key;
542
543                 if ( ! $this->_exists( $key, $group ) )
544                         return false;
545
546                 if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
547                         $this->cache[ $group ][ $key ] = 0;
548
549                 $offset = (int) $offset;
550
551                 $this->cache[ $group ][ $key ] += $offset;
552
553                 if ( $this->cache[ $group ][ $key ] < 0 )
554                         $this->cache[ $group ][ $key ] = 0;
555
556                 return $this->cache[ $group ][ $key ];
557         }
558
559         /**
560          * Replace the contents in the cache, if contents already exist
561          *
562          * @since 2.0.0
563          * @see WP_Object_Cache::set()
564          *
565          * @param int|string $key What to call the contents in the cache
566          * @param mixed $data The contents to store in the cache
567          * @param string $group Where to group the cache contents
568          * @param int $expire When to expire the cache contents
569          * @return bool False if not exists, true if contents were replaced
570          */
571         public function replace( $key, $data, $group = 'default', $expire = 0 ) {
572                 if ( empty( $group ) )
573                         $group = 'default';
574
575                 $id = $key;
576                 if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
577                         $id = $this->blog_prefix . $key;
578
579                 if ( ! $this->_exists( $id, $group ) )
580                         return false;
581
582                 return $this->set( $key, $data, $group, (int) $expire );
583         }
584
585         /**
586          * Reset keys
587          *
588          * @since 3.0.0
589          * @deprecated 3.5.0
590          */
591         public function reset() {
592                 _deprecated_function( __FUNCTION__, '3.5', 'switch_to_blog()' );
593
594                 // Clear out non-global caches since the blog ID has changed.
595                 foreach ( array_keys( $this->cache ) as $group ) {
596                         if ( ! isset( $this->global_groups[ $group ] ) )
597                                 unset( $this->cache[ $group ] );
598                 }
599         }
600
601         /**
602          * Sets the data contents into the cache
603          *
604          * The cache contents is grouped by the $group parameter followed by the
605          * $key. This allows for duplicate ids in unique groups. Therefore, naming of
606          * the group should be used with care and should follow normal function
607          * naming guidelines outside of core WordPress usage.
608          *
609          * The $expire parameter is not used, because the cache will automatically
610          * expire for each time a page is accessed and PHP finishes. The method is
611          * more for cache plugins which use files.
612          *
613          * @since 2.0.0
614          *
615          * @param int|string $key What to call the contents in the cache
616          * @param mixed $data The contents to store in the cache
617          * @param string $group Where to group the cache contents
618          * @param int $expire Not Used
619          * @return bool Always returns true
620          */
621         public function set( $key, $data, $group = 'default', $expire = 0 ) {
622                 if ( empty( $group ) )
623                         $group = 'default';
624
625                 if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
626                         $key = $this->blog_prefix . $key;
627
628                 if ( is_object( $data ) )
629                         $data = clone $data;
630
631                 $this->cache[$group][$key] = $data;
632                 return true;
633         }
634
635         /**
636          * Echoes the stats of the caching.
637          *
638          * Gives the cache hits, and cache misses. Also prints every cached group,
639          * key and the data.
640          *
641          * @since 2.0.0
642          */
643         public function stats() {
644                 echo "<p>";
645                 echo "<strong>Cache Hits:</strong> {$this->cache_hits}<br />";
646                 echo "<strong>Cache Misses:</strong> {$this->cache_misses}<br />";
647                 echo "</p>";
648                 echo '<ul>';
649                 foreach ($this->cache as $group => $cache) {
650                         echo "<li><strong>Group:</strong> $group - ( " . number_format( strlen( serialize( $cache ) ) / 1024, 2 ) . 'k )</li>';
651                 }
652                 echo '</ul>';
653         }
654
655         /**
656          * Switch the interal blog id.
657          *
658          * This changes the blog id used to create keys in blog specific groups.
659          *
660          * @since 3.5.0
661          *
662          * @param int $blog_id Blog ID
663          */
664         public function switch_to_blog( $blog_id ) {
665                 $blog_id = (int) $blog_id;
666                 $this->blog_prefix = $this->multisite ? $blog_id . ':' : '';
667         }
668
669         /**
670          * Utility function to determine whether a key exists in the cache.
671          *
672          * @since 3.4.0
673          *
674          * @access protected
675          * @param string $key
676          * @param string $group
677          * @return bool
678          */
679         protected function _exists( $key, $group ) {
680                 return isset( $this->cache[ $group ] ) && ( isset( $this->cache[ $group ][ $key ] ) || array_key_exists( $key, $this->cache[ $group ] ) );
681         }
682
683         /**
684          * Sets up object properties; PHP 5 style constructor
685          *
686          * @since 2.0.8
687          */
688         public function __construct() {
689                 global $blog_id;
690
691                 $this->multisite = is_multisite();
692                 $this->blog_prefix =  $this->multisite ? $blog_id . ':' : '';
693
694
695                 /**
696                  * @todo This should be moved to the PHP4 style constructor, PHP5
697                  * already calls __destruct()
698                  */
699                 register_shutdown_function( array( $this, '__destruct' ) );
700         }
701
702         /**
703          * Will save the object cache before object is completely destroyed.
704          *
705          * Called upon object destruction, which should be when PHP ends.
706          *
707          * @since  2.0.8
708          *
709          * @return bool True value. Won't be used by PHP
710          */
711         public function __destruct() {
712                 return true;
713         }
714 }