Function __global->apply_tempcode_escaping

Definitions

sources/tempcode.php

  • Apply whatever escaping is requested to the given value (by reference).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$escaped array No No required parameter N/A N/A A list of escaping to do
&$value string Yes No required parameter N/A N/A The string to apply the escapings to

Returns

  • Output string (you do not need to collect this, as $value is pass-by-reference -- but this is useful for chaining)
  • Type: string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Apply whatever escaping is requested to the given value (by reference).
 *
 * @param  array $escaped A list of escaping to do
 * @param  string $value The string to apply the escapings to
 * @return string Output string (you do not need to collect this, as $value is pass-by-reference -- but this is useful for chaining)
 */

function apply_tempcode_escaping(array $escaped, string &$value) : string