Mastering PHP’s addcslashes(): Escape Characters Made Easy

addcslashes()

is a PHP string‑handling function that adds a backslash before each character specified in a character list, allowing developers to escape characters for safe use in particular contexts.

addcslashes() function syntax

string addcslashes(string $str, string $charlist)

The $str parameter is the input string to be processed, and $charlist is a string containing the characters that should be escaped.

Basic usage example

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

echo addcslashes($str, $charlist);

Output: Hello, \World! This demonstrates that the character W is prefixed with a backslash.

Important notes

addcslashes()

only escapes the characters listed in $charlist; it does not affect other characters. To escape every character that needs it, use PHP’s built‑in addslashes() function.

The function can also escape special characters such as single quotes ( '), double quotes ( "), and backslashes ( \), which are common sources of syntax errors.

Escaping special characters

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

echo addcslashes($str, $charlist);

Output: I\'m a \"PHP\" developer. Here, both the single quote and double quote are prefixed with backslashes, ensuring the string is correctly interpreted.

Summary

addcslashes()

adds backslashes before specified characters, making it useful for escaping characters in strings to avoid unexpected results in PHP scripts.