WireTextTools::findReplaceEscapeChars() method

Find escaped characters in $str, replace them with a placeholder, and return the placeholders


Available since version 3.0.162.


// 1. Escape certain chars in a string that you want to survive some processing:
$str = 'Hello \*world\* foo \"bar\" baz';

// 2. Use this method to find escape chars and replace them temporarily:
$a = $sanitizer->getTextTools()->findReplaceEscapeChars($str, [ '*', '"' ]);

// 3. Process string with anything that you want NOT to see chars that were escaped:
$str = some_function_that_processes_the_string($str);

// 4. Do this to restore the escaped chars (restored without backslashes by default):
$str = str_replace(array_keys($a), array_values($a), $str); 


// basic usage
$array = $wireTextTools->findReplaceEscapeChars($str, array $escapeChars);

// usage with all arguments
$array = $wireTextTools->findReplaceEscapeChars($str, array $escapeChars, array $options = []);



Array of chars you want to escape i.e. [ '*', '[', ']', '(', ')', '`', '_', '\', '"' ]

options (optional)array

Options to modify behavior:

  • escapePrefix (string): Character used to escape another character (default is backslash).
  • restoreEscape (bool): Should returned array also include the escape prefix, so escapes are restored? (default=false)
  • gluePrefix (string): Prefix for placeholders we substitute for escaped characters (default='{ESC')
  • glueSuffix (string): Suffix for placeholders we substitute for escaped characters (default='}')
  • unescapeUnknown (bool): If we come across escaped char not in your $escapeChars list, unescape it? (default=false)
  • removeUnknown (bool): If we come across escaped char not in your $escapeChars list, remove the escape and char? (default=false)

Return value


Returns assoc array where keys are placeholders substituted in $str and values are escaped characters.

WireTextTools methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #517
    In the 517th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module called Reactions, and more. Read on!
    Weekly.pw / 6 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH