$cache->save() method

Save data to cache with given name

Example

$value = "This is the value that will be cached.";

// cache the value, using default expiration (daily)
$cache->save("my-cache-name", $value);

// cache the value, and expire after 1 hour (3600 seconds)
$cache->save("my-cache-name", $value, 3600);

Usage

// basic usage
$bool = $cache->save(string $name, $data);

// usage with all arguments
$bool = $cache->save(string $name, $data, $expire = 86400);

Arguments

Name Type(s) Description

Name	Type(s)	Description
`name`	string	Name of cache, can be any string up to 255 chars
`data`	string, array, PageArray	Data that you want to cache. May be string, array of non-object values, or PageArray.
`expire` (optional)	int, string, Page	Lifetime of this cache, in seconds, OR one of the following: Specify one of the `WireCache::expire*` constants. Specify the future date you want it to expire (as unix timestamp or any `strtotime()` compatible date format) Provide a `Page` object to expire when any page using that template is saved. Specify `WireCache::expireNever` to prevent expiration. Specify `WireCache::expireSave` to expire when any page or template is saved. Specify selector string matching pages that–when saved–expire the cache.

name

string

Name of cache, can be any string up to 255 chars

data

string, array, PageArray

Data that you want to cache. May be string, array of non-object values, or PageArray.

expire (optional)

int, string, Page

Lifetime of this cache, in seconds, OR one of the following:

Specify one of the WireCache::expire* constants.
Specify the future date you want it to expire (as unix timestamp or any strtotime() compatible date format)
Provide a Page object to expire when any page using that template is saved.
Specify WireCache::expireNever to prevent expiration.
Specify WireCache::expireSave to expire when any page or template is saved.
Specify selector string matching pages that–when saved–expire the cache.

Return value

bool

Returns true if cache was successful, false if not

Exceptions

Method can throw exceptions on error:

WireException - if given data that cannot be cached

$cache methods and properties

API reference based on ProcessWire core version 3.0.236

Save data to cache with given name

Example

Usage

Arguments

Return value

Exceptions

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news