$cache->get() method

Get data from cache with given name

Optionally specify expiration time and/or a cache generation function to use when cache needs to be created.

Cached value can be a string, an array of non-object values, or a PageArray.

Example

// get single cache value 
$str = $cache->get('foo');

// get 3 cached values, returns associative array with foo, bar, baz indexes
$array = $cache->get([ 'foo', 'bar', 'baz' ]);

// get all cache values with names starting with “hello”
$array = $cache->get('hello*');

// get cache only if it’s less than or equal to 1 hour old (3600 seconds)
$str = $cache->get('foo', 3600);

// same as above, but also generates the cache value with function when expired
$str = $cache->get('foo', 3600, function() {
  return "This is the cached value";
});

Usage

// basic usage
$string = $cache->get($name);

// usage with all arguments
$string = $cache->get($name, $expire = null, callable $func = null);

Arguments

NameType(s)Description
namestring, array

Provide a single cache name, an array of cache names, or an asterisk cache name.

  • If given a single cache name (string) just the contents of that cache will be returned.
  • If given an array of names, multiple caches will be returned, indexed by cache name.
  • If given a cache name with an asterisk in it, it will return an array of all matching caches.
expire (optional)int, string, null

Optionally specify max age (in seconds) OR oldest date string.

  • If cache exists and is older, then blank returned. You may omit this to divert to whatever expiration was specified at save() time. Note: The $expire and $func arguments may optionally be reversed.
  • If using a $func, the behavior of $expire becomes the same as that of save().
func (optional)callable

Optionally provide a function/closure that generates the cache value and it will be used when needed. This option requires that only one cache is being retrieved (not an array of caches). Note: The $expire and $func arguments may optionally be reversed.

Return value

string array PageArray mixed null

Returns null if cache doesn’t exist and no generation function provided.

Exceptions

Method can throw exceptions on error:

  • WireException - if given invalid arguments


$cache methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022
  • ProcessWire 3.0.198 core updates: in this post we take a closer look at 3 useful new features added in this version— More
    15 April 2022

Latest news

  • ProcessWire Weekly #418
    In the 418th issue of ProcessWire Weekly we'll cover recent highlights, share some tips and tricks, and check out the new master version of ProcessWire, 3.0.200. Read on!
    Weekly.pw / 14 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani