Function Hook_actionlog->apply_string_parameter_substitutions

Definitions

sources/actionlog.php

  • Apply any page-link/URL parameter value substitutions to a string.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
&$string string Yes No required parameter N/A N/A The string to apply to, changed by reference
$bindings array No No required parameter N/A N/A Mapping of bindings to apply

Returns

  • Whether successful applying the bindings (false: null or missing binding)
  • Type: ~boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Apply any page-link/URL parameter value substitutions to a string.
 *
 * @param  string $string The string to apply to, changed by reference
 * @param  array $bindings Mapping of bindings to apply
 * @return ~boolean Whether successful applying the bindings (false: null or missing binding)
 */
protected function apply_string_parameter_substitutions(string &$string, array $bindings)