| 5 cache.inc | cache_get($key, $table = 'cache') |
| 6 cache-install.inc | cache_get( |
| 6 cache.inc | cache_get($cid, |
| 7 cache.inc | cache_get($cid, $bin = 'cache') |
Returns data from the persistent cache.
Data may be stored as either plain text or as serialized data. cache_get will automatically return unserialized objects and arrays.
Parameters
$cid: The cache ID of the data to retrieve.
$bin: The cache bin to store the data in. Valid core values are 'cache_block', 'cache_bootstrap', 'cache_field', 'cache_filter', 'cache_form', 'cache_menu', 'cache_page', 'cache_path', 'cache_update' or 'cache' for the default cache.
Return value
The cache or FALSE on failure.
See also
File
- includes/
cache.inc, line 55 - Functions and interfaces for cache handling.
Code
<?php
function cache_get($cid, $bin = 'cache') {
return _cache_get_object($bin)->get($cid);
}
?>
Comments
Return Value
The return value is an object representing the row in the cache table. To get the actual value out, access the data property. The data property is already unserialized.
Example:
<?phpcache_set($cid, $myObject);
// ...
$cache = cache_get($cid);
$myObject = $cache->data;
?>
$cid Convention
Note that $cid is a string. The convention seems to be to use colons to create a sort of namespacing. So your module may want to do something like $cid = 'mymodule:mything:50';
This function will return
This function will return expired items in Drupal 7, here is the core issue for fixing in D8:
http://drupal.org/node/534092
This is not obvious from these API docs which is why I'm adding this note here.