$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.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • 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