Function __global->_delete_cache_entry

Definitions

sources/caches2.php

  • Remove an item from the general cache (most commonly used for blocks).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$cached_for mixed No No required parameter N/A N/A The type of what we are caching (e.g. block name) (ID_TEXT or an array of ID_TEXT, the array may be pairs re-specifying $identifier)
$identifier ?array No No Null N/A N/A A map of identifying characteristics (null: no identifying characteristics, decache all OR $cached_for is an array)
$member_id ?MEMBER No No Null N/A N/A Member to only decache for (null: no limit)

Preview

Code (PHP)

/**
 * Remove an item from the general cache (most commonly used for blocks).
 *
 * @param  mixed $cached_for The type of what we are caching (e.g. block name) (ID_TEXT or an array of ID_TEXT, the array may be pairs re-specifying $identifier)
 * @param  ?array $identifier A map of identifying characteristics (null: no identifying characteristics, decache all OR $cached_for is an array)
 * @param  ?MEMBER $member_id Member to only decache for (null: no limit)
 */
function _delete_cache_entry($cached_for, ?array $identifier = null, ?int $member_id = null)