Function __global->map_table_field

Definitions

sources/templates_map_table.php

  • Get the Tempcode for a map field.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$name mixed No No required parameter N/A N/A The field title, provided in plain-text format or as HTML via do_lang_tempcode/protect_from_escaping (string or Tempcode)
$value mixed No No required parameter N/A N/A The field value, 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)
$abbr string No No Blank (empty string) N/A N/A Field abbreviation (blank: none)

Returns

  • The generated map field
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the Tempcode for a map field.
 *
 * @param  mixed $name The field title, provided in plain-text format or as HTML via do_lang_tempcode/protect_from_escaping (string or Tempcode)
 * @param  mixed $value The field value, 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)
 * @param  string $abbr Field abbreviation (blank: none)
 * @return Tempcode The generated map field
 */
function map_table_field($name, $value, bool $auto_escape, string $abbr = '') : object