replace

Replaces occurrences of substring1 in a string with substring2,
in a specified scope. The search is case-sensitive. Function returns original string with replacements made.

replace(String, substring1, substring2 [, scope]) → returns String

Argument Reference for the replace function

String

Required: Yes
String to search

substring1

Required: Yes
Substring to find within string

substring2

Required: Yes
Substring to replace substring1 with. As of CF 2016+ you can also pass a callback function in this argument function(pattern, position, originalString).

scope

Required: No
Default: one
* one: replace the first occurrence
* all: replace all occurrences Values:
  • one
  • all

Examples sample code invoking the replace function


Script Syntax

getVal = replace("ColdFUsion", "U", "u"); 
 writeDump(getVal);

Expected Result: Expected Result: ColdFusion


Tag Syntax

getVal1 = replace("COldFusiOn", "O", "o", "ONE"); 
 writeDump(getVal1);

Expected Result: Expected Result: ColdFusiOn


Example using Callback Function

In CF 2016+ you can pass in a callback function to the third argument of the replace function

public function upCase(pattern, position, orig) {
    return uCase(pattern);
}
result = replace("A man a plan a canal.","an", upCase , "ALL");
writeOutput(result);

Expected Result: A mAN a plAN a cANal.


Fork me on GitHub