ColdFusion | Replace function

Description

Replaces occurrences of substring1 in a string with an object in a specified scope. The search is case sensitive.

This function can take either string or callback function as an argument instead of the argument to replace the string.

Returns

The string, after making replacements.

Function syntax

Replace(string, substring1, obj [, scope ])

Parameters

Parameter	Description
string	A string or a variable that contains one. String in which to search.
substring1	A string or a variable that contains one. String for which to search
obj	String that replaces substring1 or callback function.
scope	one: replaces the first occurrence (default) all: replaces all occurrences

Usage

To remove a string, specify the empty string ("") as substring2.You do not need to escape comma characters in strings. For example, the following code deletes the commas from the sentence:

replace("The quick brown fox jumped over the lazy cow, dog, and cat.",",","","All")

Example

<cfoutput>#replace("The quick brown fox","o","cf","all")#</cfoutput>

The code produces the following output:

The quick brcfwn fcfx

Example with callback function

<p><cfoutput>replace("The quick brown fox jumped over the lazy cow.","ow",callBackFn) is 
<b>#replace("The quick brown fox jumped over the lazy cow.","ow",callBackFn)#</b></cfoutput></p>
<cffunction name="callBackFn" access="public" >
   <cfargument name="regExp">
   <cfargument name="position">
   <cfargument name="original">
        <cfset retString = regExp.reverse()&"aze">
   <cfreturn retString>
</cffunction>

The code produces the following output:

replace("The quick brown fox jumped over the lazy cow.","ow",callBackFn) is The quick brwoazen fox jumped over the lazy cow.

Replace

Applies to