PHP | addcslashes() Function

The addcslashes() function is a built-in function in PHP. The addcslashes() function is used to add backslashes before some specified characters in a given string.

Syntax:

string addcslashes($string, $characters)

Parameters: This function accepts two parameters as shown in the above syntax and are described below:



  1. $string: This parameter specifies the input string which is needed to be escaped. Or we can also say that the string in which we want to add backslashes before some specified characters.
  2. $characters: This parameter specifies a character or sequence of characters which we want to escape in the input string by adding backslashes before them. We can specify a range of characters as ‘a..z’. That is the start character of the range followed by two dots and the ending character.
    Note: Please use characters like a,b,n,t etc carefully as this parameter as \a,\b,\n,\t are predefined escape sequences and have some special meaning. So, we might not get the desired result.

Return Value: This function returns a escaped string which is the input string $string with backslashes added before $characters.

Examples:

Input: $string = "GeeksforGeeks"  $characters = 'e'
Output: G\e\eksforG\e\eks

Input: $string = "GeeksforGeeks" $characters = 'a..k'
Output: G\e\e\ksnG\e\e\ks

Below programs illustrate the addcslashes() function in PHP:

Program 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
// PHP program to illustrate addcslashes()
// function
  
$str = "GeeksforGeeks";
  
$resStr = addcslashes($str, 'e');
  
echo $resStr;
  
?>

chevron_right


Output:

G\e\eksforG\e\eks

Program 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
// PHP program to illustrate addcslashes()
// function
  
$str = "GeeksnGeeks";
$resStr = addcslashes($str, 'a..k');
  
echo $resStr;
  
?>

chevron_right


Output:

G\e\e\ksnG\e\e\ks

Reference:
http://php.net/manual/en/function.addcslashes.php



My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.




Article Tags :
Practice Tags :


Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.