WireTextTools::findReplaceEscapeChars() method

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

Usage

Available since version 3.0.162.

Example

// 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); 

Usage

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

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

Arguments

NameType(s)Description
str
escapeCharsarray

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

array

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 #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.