Master PHP’s addcslashes(): Escape Characters Like a Pro

addcslashes()

is a PHP string function that adds backslashes before specified characters.

addcslashes() Function Syntax

string addcslashes(string $str, string $charlist)

Where $str is the input string to be processed, and $charlist is a string that defines the characters to be escaped.

The function inserts a backslash before each character in $charlist, which is useful when you need to escape special characters in a string.

How to Use addcslashes()

$str = "Hello, World!";
$charlist = "W";

echo addcslashes($str, $charlist);

The output will be: Hello, \World! In this example, the character "W" in the string "Hello, World!" is escaped with a backslash.

Note that addcslashes() only adds backslashes before the characters you specify; it does not escape other characters. To escape an entire string, you can use PHP’s built‑in addslashes() function.

Additionally, addcslashes() can handle special characters such as single quotes ('), double quotes ("), and backslashes (\), which may cause errors in certain contexts.

Escaping Special Characters with addcslashes()

$str = 'I\'m a "PHP" developer.';
$charlist = "'\"";

echo addcslashes($str, $charlist);

The output will be: I\'m a \"PHP\" developer. Here, both the single quote and double quote characters are escaped with backslashes.

Conclusion

addcslashes()

is a PHP string function that adds backslashes before specified characters, helping you avoid unexpected results in specific contexts. Use it to escape special characters and ensure your strings are processed correctly.