Function __global->do_block_get_cache_identifier

Definitions

sources/zones.php

  • Takes a string which is a PHP expression over $map (parameter map), and returns a derived identifier.We see if we have something cached by looking for a matching identifier.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$codename ID_TEXT No No required parameter N/A N/A The block name
$cache_on mixed No No required parameter N/A N/A PHP expression over $map (the parameter map of the block) OR a call_user_func specifier that will return a result (which will be used if caching is really very important, even for Hip Hop PHP)
$map array No No required parameter N/A N/A The block parameter map

Returns

  • The derived cache identifier (null: the identifier is CURRENTLY null meaning cannot be cached)
  • Type: ?LONG_TEXT
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Takes a string which is a PHP expression over $map (parameter map), and returns a derived identifier.We see if we have something cached by looking for a matching identifier.
 *
 * @param  ID_TEXT $codename The block name
 * @param  mixed $cache_on PHP expression over $map (the parameter map of the block) OR a call_user_func specifier that will return a result (which will be used if caching is really very important, even for Hip Hop PHP)
 * @param  array $map The block parameter map
 * @return ?LONG_TEXT The derived cache identifier (null: the identifier is CURRENTLY null meaning cannot be cached)
 */
function do_block_get_cache_identifier(string $codename, $cache_on, array $map) : ?string