4.6.x bootstrap.inc cache_set($cid, $data, $expire = CACHE_PERMANENT, $headers = NULL)
4.7.x bootstrap.inc cache_set($cid, $data, $expire = CACHE_PERMANENT, $headers = NULL)
5.x cache.inc cache_set($cid, $table = 'cache', $data, $expire = CACHE_PERMANENT, $headers = NULL)
6.x cache.inc cache_set($cid, $data, $table = 'cache', $expire = CACHE_PERMANENT, $headers = NULL)
6.x cache-install.inc cache_set($cid, $data, $table = 'cache', $expire = CACHE_PERMANENT, $headers = NULL)
7.x cache.inc cache_set($cid, $data, $bin = 'cache', $expire = CACHE_PERMANENT)

Store data in the persistent cache.

The persistent cache is split up into four database tables. Contributed modules can add additional tables.

'cache_page': This table stores generated pages for anonymous users. This is the only table affected by the page cache setting on the administrator panel.

'cache_menu': Stores the cachable part of the users' menus.

'cache_filter': Stores filtered pieces of content. This table is periodically cleared of stale entries by cron.

'cache': Generic cache storage table.

The reasons for having several tables are as follows:

  • smaller tables allow for faster selects and inserts
  • we try to put fast changing cache items and rather static ones into different tables. The effect is that only the fast changing tables will need a lot of writes to disk. The more static tables will also be better cachable with MySQL's query cache

Parameters

$cid: The cache ID of the data to store.

$data: The data to store in the cache. Complex data types will be automatically serialized before insertion. Strings will be stored as plain text and not serialized.

$table: The table $table to store the data in. Valid core values are 'cache_filter', 'cache_menu', 'cache_page', or 'cache'.

$expire: One of the following values:

  • CACHE_PERMANENT: Indicates that the item should never be removed unless explicitly told to using cache_clear_all() with a cache ID.
  • CACHE_TEMPORARY: Indicates that the item should be removed at the next general cache wipe.
  • A Unix timestamp: Indicates that the item should be kept at least until the given time, after which it behaves like CACHE_TEMPORARY.

$headers: A string containing HTTP header information for cached pages.

@see cache_get()

11 calls to cache_set()
block_list in modules/block/block.module
Return all blocks in the specified region for the current user.
book_menu_subtree_data in modules/book/book.module
Get the data representing a subtree of the book hierarchy.
check_markup in modules/filter/filter.module
Run all the enabled filters on a piece of text.
drupal_get_schema in includes/common.inc
Get the schema definition of a table, or the whole database schema.
form_set_cache in includes/form.inc
Store a form in the cache.

... See full list

File

includes/cache.inc, line 105

Code

function cache_set($cid, $data, $table = 'cache', $expire = CACHE_PERMANENT, $headers = NULL) {
  $serialized = 0;
  if (is_object($data) || is_array($data)) {
    $data = serialize($data);
    $serialized = 1;
  }
  $created = time();
  db_query("UPDATE {" . $table . "} SET data = %b, created = %d, expire = %d, headers = '%s', serialized = %d WHERE cid = '%s'", $data, $created, $expire, $headers, $serialized, $cid);
  if (!db_affected_rows()) {
    @db_query("INSERT INTO {" . $table . "} (cid, data, created, expire, headers, serialized) VALUES ('%s', %b, %d, %d, '%s', %d)", $cid, $data, $created, $expire, $headers, $serialized);
  }
}

Comments

Alexander Allen’s picture

Does that mean that the cache item gets removed by cache_clear_all()?

mikeytown2’s picture

If your using the "cache" table then yes. If you have your own cache table then you need to implement hook_flush_caches.

rocket777’s picture

Yes, I think that's what it means.