Function __global->do_block_hunt_file

Definitions

sources/zones.php

  • Get the block object for a given block codename.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

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
$map array No No [] N/A N/A The block parameter map

Returns

  • A pair: Either the block object, or the string output of a miniblock ; and whether we entered a new security scope
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the block object for a given block codename.
 *
 * @param  ID_TEXT $codename The block name
 * @param  array $map The block parameter map
 * @return array A pair: Either the block object, or the string output of a miniblock ; and whether we entered a new security scope
 */

function do_block_hunt_file(string $codename, array $map = []) : array