enmi-conf.org: comparison wp/wp-includes/cache.php

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 <?php
 /**
 * Object Cache API
 *
-* @link https://codex.wordpress.org/Class_Reference/WP_Object_Cache
+* @link https://developer.wordpress.org/reference/classes/wp_object_cache/
 *
 * @package WordPress
 * @subpackage Cache
 */
 /** WP_Object_Cache class */
 require_once ABSPATH . WPINC . '/class-wp-object-cache.php';
+/**
+* Sets up Object Cache Global and assigns it.
+*
+* @since 2.0.0
+*
+* @global WP_Object_Cache $wp_object_cache
+*/
+function wp_cache_init() {
+	$GLOBALS['wp_object_cache'] = new WP_Object_Cache();
+}
 /**
 * Adds data to the cache, if the cache key doesn't already exist.
 *
 * @since 2.0.0
 	return $wp_object_cache->add( $key, $data, $group, (int) $expire );
 }
 /**
-* Closes the cache.
+* Adds multiple values to the cache in one call.
 *
-* This function has ceased to do anything since WordPress 2.5. The
+* @since 6.0.0
-* functionality was removed along with the rest of the persistent cache.
+*
-*
+* @see WP_Object_Cache::add_multiple()
-* This does not mean that plugins can't implement this function when they need
+* @global WP_Object_Cache $wp_object_cache Object cache global instance.
-* to make sure that the cache is cleaned up after WordPress no longer needs it.
+*
-*
+* @param array  $data   Array of keys and values to be set.
-* @since 2.0.0
+* @param string $group  Optional. Where the cache contents are grouped. Default empty.
-*
+* @param int    $expire Optional. When to expire the cache contents, in seconds.
-* @return true Always returns true.
+*                       Default 0 (no expiration).
-*/
+* @return bool[] Array of return values, grouped by key. Each value is either
-function wp_cache_close() {
+*                true on success, or false if cache key and group already exist.
-	return true;
+*/
-}
+function wp_cache_add_multiple( array $data, $group = '', $expire = 0 ) {
+	global $wp_object_cache;
-/**
-* Decrements numeric cache item's value.
+	return $wp_object_cache->add_multiple( $data, $group, $expire );
-*
+}
-* @since 3.3.0
-*
+/**
-* @see WP_Object_Cache::decr()
+* Replaces the contents of the cache with new data.
-* @global WP_Object_Cache $wp_object_cache Object cache global instance.
+*
-*
+* @since 2.0.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.
+* @see WP_Object_Cache::replace()
-* @param string     $group  Optional. The group the key is in. Default empty.
+* @global WP_Object_Cache $wp_object_cache Object cache global instance.
-* @return int|false The item's new value on success, false on failure.
+*
-*/
+* @param int|string $key    The key for the cache data that should be replaced.
-function wp_cache_decr( $key, $offset = 1, $group = '' ) {
+* @param mixed      $data   The new data to store in the cache.
-	global $wp_object_cache;
+* @param string     $group  Optional. The group for the cache data that should be replaced.
+*                           Default empty.
-	return $wp_object_cache->decr( $key, $offset, $group );
+* @param int        $expire Optional. When to expire the cache contents, in seconds.
-}
+*                           Default 0 (no expiration).
+* @return bool True if contents were replaced, false if original value does not exist.
-/**
+*/
-* Removes the cache contents matching key and group.
+function wp_cache_replace( $key, $data, $group = '', $expire = 0 ) {
-*
+	global $wp_object_cache;
-* @since 2.0.0
-*
+	return $wp_object_cache->replace( $key, $data, $group, (int) $expire );
-* @see WP_Object_Cache::delete()
+}
-* @global WP_Object_Cache $wp_object_cache Object cache global instance.
-*
+/**
-* @param int|string $key   What the contents in the cache are called.
+* Saves the data to the cache.
-* @param string     $group Optional. Where the cache contents are grouped. Default empty.
+*
-* @return bool True on successful removal, false on failure.
+* Differs from wp_cache_add() and wp_cache_replace() in that it will always write data.
-*/
+*
-function wp_cache_delete( $key, $group = '' ) {
+* @since 2.0.0
-	global $wp_object_cache;
+*
+* @see WP_Object_Cache::set()
-	return $wp_object_cache->delete( $key, $group );
+* @global WP_Object_Cache $wp_object_cache Object cache global instance.
-}
+*
+* @param int|string $key    The cache key to use for retrieval later.
-/**
+* @param mixed      $data   The contents to store in the cache.
-* Removes all cache items.
+* @param string     $group  Optional. Where to group the cache contents. Enables the same key
-*
+*                           to be used across groups. Default empty.
-* @since 2.0.0
+* @param int        $expire Optional. When to expire the cache contents, in seconds.
-*
+*                           Default 0 (no expiration).
-* @see WP_Object_Cache::flush()
-* @global WP_Object_Cache $wp_object_cache Object cache global instance.
-*
 * @return bool True on success, false on failure.
 */
-function wp_cache_flush() {
+function wp_cache_set( $key, $data, $group = '', $expire = 0 ) {
 	global $wp_object_cache;
-	return $wp_object_cache->flush();
+	return $wp_object_cache->set( $key, $data, $group, (int) $expire );
+}
+/**
+* Sets multiple values to the cache in one call.
+*
+* @since 6.0.0
+*
+* @see WP_Object_Cache::set_multiple()
+* @global WP_Object_Cache $wp_object_cache Object cache global instance.
+*
+* @param array  $data   Array of keys and values to be set.
+* @param string $group  Optional. Where the cache contents are grouped. Default empty.
+* @param int    $expire Optional. When to expire the cache contents, in seconds.
+*                       Default 0 (no expiration).
+* @return bool[] Array of return values, grouped by key. Each value is either
+*                true on success, or false on failure.
+*/
+function wp_cache_set_multiple( array $data, $group = '', $expire = 0 ) {
+	global $wp_object_cache;
+	return $wp_object_cache->set_multiple( $data, $group, $expire );
 }
 /**
 * Retrieves the cache contents from the cache by key and group.
 *
 *
 * @param array  $keys  Array of keys under which the cache contents are stored.
 * @param string $group Optional. Where the cache contents are grouped. Default empty.
 * @param bool   $force Optional. Whether to force an update of the local cache
 *                      from the persistent cache. Default false.
-* @return array Array of values organized into groups.
+* @return array Array of return values, grouped by key. Each value is either
+*               the cache contents on success, or false on failure.
 */
 function wp_cache_get_multiple( $keys, $group = '', $force = false ) {
 	global $wp_object_cache;
 	return $wp_object_cache->get_multiple( $keys, $group, $force );
 }
 /**
-* Increment numeric cache item's value
+* Removes the cache contents matching key and group.
+*
+* @since 2.0.0
+*
+* @see WP_Object_Cache::delete()
+* @global WP_Object_Cache $wp_object_cache Object cache global instance.
+*
+* @param int|string $key   What the contents in the cache are called.
+* @param string     $group Optional. Where the cache contents are grouped. Default empty.
+* @return bool True on successful removal, false on failure.
+*/
+function wp_cache_delete( $key, $group = '' ) {
+	global $wp_object_cache;
+	return $wp_object_cache->delete( $key, $group );
+}
+/**
+* Deletes multiple values from the cache in one call.
+*
+* @since 6.0.0
+*
+* @see WP_Object_Cache::delete_multiple()
+* @global WP_Object_Cache $wp_object_cache Object cache global instance.
+*
+* @param array  $keys  Array of keys under which the cache to deleted.
+* @param string $group Optional. Where the cache contents are grouped. Default empty.
+* @return bool[] Array of return values, grouped by key. Each value is either
+*                true on success, or false if the contents were not deleted.
+*/
+function wp_cache_delete_multiple( array $keys, $group = '' ) {
+	global $wp_object_cache;
+	return $wp_object_cache->delete_multiple( $keys, $group );
+}
+/**
+* Increments numeric cache item's value.
 *
 * @since 3.3.0
 *
 * @see WP_Object_Cache::incr()
 * @global WP_Object_Cache $wp_object_cache Object cache global instance.
 *
 * @param int|string $key    The key for the cache contents that should be incremented.
-* @param int        $offset Optional. The amount by which to increment the item's value. Default 1.
+* @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 empty.
 * @return int|false The item's new value on success, false on failure.
 */
 function wp_cache_incr( $key, $offset = 1, $group = '' ) {
 	global $wp_object_cache;
 	return $wp_object_cache->incr( $key, $offset, $group );
 }
 /**
-* Sets up Object Cache Global and assigns it.
+* Decrements numeric cache item's value.
 *
-* @since 2.0.0
+* @since 3.3.0
 *
-* @global WP_Object_Cache $wp_object_cache
+* @see WP_Object_Cache::decr()
-*/
+* @global WP_Object_Cache $wp_object_cache Object cache global instance.
-function wp_cache_init() {
+*
-	$GLOBALS['wp_object_cache'] = new WP_Object_Cache();
+* @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 empty.
-* Replaces the contents of the cache with new data.
+* @return int|false The item's new value on success, false on failure.
-*
+*/
-* @since 2.0.0
+function wp_cache_decr( $key, $offset = 1, $group = '' ) {
-*
+	global $wp_object_cache;
-* @see WP_Object_Cache::replace()
-* @global WP_Object_Cache $wp_object_cache Object cache global instance.
+	return $wp_object_cache->decr( $key, $offset, $group );
-*
+}
-* @param int|string $key    The key for the cache data that should be replaced.
-* @param mixed      $data   The new data to store in the cache.
+/**
-* @param string     $group  Optional. The group for the cache data that should be replaced.
+* Removes all cache items.
-*                           Default empty.
+*
-* @param int        $expire Optional. When to expire the cache contents, in seconds.
+* @since 2.0.0
-*                           Default 0 (no expiration).
+*
-* @return bool False if original value does not exist, true if contents were replaced
+* @see WP_Object_Cache::flush()
-*/
+* @global WP_Object_Cache $wp_object_cache Object cache global instance.
-function wp_cache_replace( $key, $data, $group = '', $expire = 0 ) {
+*
-	global $wp_object_cache;
-	return $wp_object_cache->replace( $key, $data, $group, (int) $expire );
-}
-/**
-* Saves the data to the cache.
-*
-* Differs from wp_cache_add() and wp_cache_replace() in that it will always write data.
-*
-* @since 2.0.0
-*
-* @see WP_Object_Cache::set()
-* @global WP_Object_Cache $wp_object_cache Object cache global instance.
-*
-* @param int|string $key    The cache key to use for retrieval later.
-* @param mixed      $data   The contents to store in the cache.
-* @param string     $group  Optional. Where to group the cache contents. Enables the same key
-*                           to be used across groups. Default empty.
-* @param int        $expire Optional. When to expire the cache contents, in seconds.
-*                           Default 0 (no expiration).
 * @return bool True on success, false on failure.
 */
-function wp_cache_set( $key, $data, $group = '', $expire = 0 ) {
+function wp_cache_flush() {
 	global $wp_object_cache;
-	return $wp_object_cache->set( $key, $data, $group, (int) $expire );
+	return $wp_object_cache->flush();
 }
 /**
-* Switches the internal blog ID.
+* Removes all cache items from the in-memory runtime cache.
 *
-* This changes the blog id used to create keys in blog specific groups.
+* @since 6.0.0
 *
-* @since 3.5.0
+* @see WP_Object_Cache::flush()
 *
-* @see WP_Object_Cache::switch_to_blog()
+* @return bool True on success, false on failure.
-* @global WP_Object_Cache $wp_object_cache Object cache global instance.
+*/
-*
+function wp_cache_flush_runtime() {
-* @param int $blog_id Site ID.
+	return wp_cache_flush();
-*/
+}
-function wp_cache_switch_to_blog( $blog_id ) {
-	global $wp_object_cache;
+/**
+* Closes the cache.
-	$wp_object_cache->switch_to_blog( $blog_id );
+*
+* This function has ceased to do anything since WordPress 2.5. The
+* functionality was removed along with the rest of the persistent cache.
+*
+* This does not mean that plugins can't implement this function when they need
+* to make sure that the cache is cleaned up after WordPress no longer needs it.
+*
+* @since 2.0.0
+*
+* @return true Always returns true.
+*/
+function wp_cache_close() {
+	return true;
 }
 /**
 * Adds a group or set of groups to the list of global groups.
 *
 function wp_cache_add_non_persistent_groups( $groups ) {
 	// Default cache doesn't persist so nothing to do here.
 }
 /**
-* Reset internal cache keys and structures.
+* Switches the internal blog ID.
+*
+* This changes the blog id used to create keys in blog specific groups.
+*
+* @since 3.5.0
+*
+* @see WP_Object_Cache::switch_to_blog()
+* @global WP_Object_Cache $wp_object_cache Object cache global instance.
+*
+* @param int $blog_id Site ID.
+*/
+function wp_cache_switch_to_blog( $blog_id ) {
+	global $wp_object_cache;
+	$wp_object_cache->switch_to_blog( $blog_id );
+}
+/**
+* Resets internal cache keys and structures.
 *
 * If the cache back end uses global blog or site IDs as part of its cache keys,
 * this function instructs the back end to reset those keys and perform any cleanup
 * since blog or site IDs have changed since cache init.
 *
 * This function is deprecated. Use wp_cache_switch_to_blog() instead of this
 * function when preparing the cache for a blog switch. For clearing the cache
 * during unit tests, consider using wp_cache_init(). wp_cache_init() is not
-* recommended outside of unit tests as the performance penalty for using it is
+* recommended outside of unit tests as the performance penalty for using it is high.
-* high.
+*
-*
+* @since 3.0.0
-* @since 2.6.0
+* @deprecated 3.5.0 Use wp_cache_switch_to_blog()
-* @deprecated 3.5.0 WP_Object_Cache::reset()
 * @see WP_Object_Cache::reset()
 *
 * @global WP_Object_Cache $wp_object_cache Object cache global instance.
 */
 function wp_cache_reset() {
-	_deprecated_function( __FUNCTION__, '3.5.0', 'WP_Object_Cache::reset()' );
+	_deprecated_function( __FUNCTION__, '3.5.0', 'wp_cache_switch_to_blog()' );
 	global $wp_object_cache;
 	$wp_object_cache->reset();
 }

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6