Function Hook_main_custom_gfx_text_overlay->run

Definitions

sources/hooks/blocks/main_custom_gfx/text_overlay.php

  • Standard graphic generator function. Creates custom graphics from parameters.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$map array No No required parameter N/A N/A Map of hook parameters (relayed from block parameters map)
&$block object Yes No required parameter N/A N/A The block itself (contains utility methods)

Returns

  • HTML to output
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Standard graphic generator function. Creates custom graphics from parameters.
 *
 * @param  array $map Map of hook parameters (relayed from block parameters map)
 * @param  object $block The block itself (contains utility methods)
 * @return Tempcode HTML to output
 */
public function run(array $map, object &$block) : object