Function __global->block_tooltip

Definitions

sources/templates_tooltip.php

  • Show a tooltip on a block element.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$label mixed No No required parameter N/A N/A What the tooltip is on, format depends on $auto_escape (string or Tempcode)
$tooltip mixed No No required parameter N/A N/A The tooltip, format depends on $auto_escape (string or Tempcode)
$auto_escape boolean No No required parameter N/A N/A Whether to automatically escape each plain-text entry so that it cannot contain HTML (ignored for Tempcode values)

Returns

  • The tooltip
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Show a tooltip on a block element.
 *
 * @param  mixed $label What the tooltip is on, format depends on $auto_escape (string or Tempcode)
 * @param  mixed $tooltip The tooltip, format depends on $auto_escape (string or Tempcode)
 * @param  boolean $auto_escape Whether to automatically escape each plain-text entry so that it cannot contain HTML (ignored for Tempcode values)
 * @return Tempcode The tooltip
 */
function block_tooltip($label, $tooltip, bool $auto_escape) : object