Automattic\WooCommerce\Caching

WPCacheEngine{} │ WC 1.0

Implementation of CacheEngine that uses the built-in WordPress cache.

Хуков нет.

Использование

$WPCacheEngine = new WPCacheEngine();
// use class methods

Методы

1. public cache_object( string $key, $object, int $expiration, string $group = '' )
2. public delete_cache_group( string $group = '' )
3. public delete_cached_object( string $key, string $group = '' )
4. public get_cached_object( string $key, string $group = '' )
5. public is_cached( string $key, string $group = '' )

Код WPCacheEngine{} WPCacheEngine{} ^{WC 7.7.2}

class WPCacheEngine implements CacheEngine {
	use CacheNameSpaceTrait;

	/**
	 * Retrieves an object cached under a given key.
	 *
	 * @param string $key They key under which the object to retrieve is cached.
	 * @param string $group The group under which the object is cached.
	 *
	 * @return array|object|null The cached object, or null if there's no object cached under the passed key.
	 */
	public function get_cached_object( string $key, string $group = '' ) {
		$prefixed_key = self::get_prefixed_key( $key, $group );
		$value        = wp_cache_get( $prefixed_key, $group );
		return false === $value ? null : $value;
	}

	/**
	 * Caches an object under a given key, and with a given expiration.
	 *
	 * @param string       $key The key under which the object will be cached.
	 * @param array|object $object The object to cache.
	 * @param int          $expiration Expiration for the cached object, in seconds.
	 * @param string       $group The group under which the object will be cached.
	 *
	 * @return bool True if the object is cached successfully, false otherwise.
	 */
	public function cache_object( string $key, $object, int $expiration, string $group = '' ): bool {
		$prefixed_key = self::get_prefixed_key( $key, $group );
		return wp_cache_set( $prefixed_key, $object, $group, $expiration );
	}

	/**
	 * Removes a cached object from the cache.
	 *
	 * @param string $key They key under which the object is cached.
	 * @param string $group The group under which the object is cached.
	 *
	 * @return bool True if the object is removed from the cache successfully, false otherwise (because the object wasn't cached or for other reason).
	 */
	public function delete_cached_object( string $key, string $group = '' ): bool {
		$prefixed_key = self::get_prefixed_key( $key, $group );
		return wp_cache_delete( $prefixed_key, $group );
	}

	/**
	 * Checks if an object is cached under a given key.
	 *
	 * @param string $key The key to verify.
	 * @param string $group The group under which the object is cached.
	 *
	 * @return bool True if there's an object cached under the given key, false otherwise.
	 */
	public function is_cached( string $key, string $group = '' ): bool {
		$prefixed_key = self::get_prefixed_key( $key, $group );
		return false !== wp_cache_get( $prefixed_key, $group );
	}

	/**
	 * Deletes all cached objects under a given group.
	 *
	 * @param string $group The group to delete.
	 *
	 * @return bool True if the group is deleted successfully, false otherwise.
	 */
	public function delete_cache_group( string $group = '' ): bool {
		return self::invalidate_cache_group( $group );
	}
}