$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

NameType(s)Description
namestring

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

datastring, 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.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits