PHP: addslashes - Manual

downloads | documentation | faq | getting help | mailing lists | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

bin2hex addcslashes

Last updated: Sat, 27 Jan 2007

view this page in

# addslashes

(PHP 3, PHP 4, PHP 5)

addslashes -- Экранирует спецсимволы в строке

## Описание

string addslashes ( string str )

Возвращает сроку `str`, в которой перед каждым спецсимволом добавлен обратный слэш (`\`), например для последующего использования этой строки в запросе к базе данных. Экранируются одиночная кавычка (`'`), дойная кавычка (`"`), обратный слэш (`\`) и NUL (байт `NULL`).

Функция addslashes() часто применяется при записи в базу данных. Предположим, если нужно внести в базу данных имя `O'reilly`, то символ `'` должен быть экранирован. В большинстве баз данных для этого используется `\`, строка будет выглядеть как `O\'reilly`. Заметьте, что сам символ `\` в базу данных записан не будет. Если директива конфигурации magic_quotes_sybase имеет значение `on`, то символ `'` будет экранироваться добавлением еще одного `'` вместо `\`.

Директива конфигурации magic_quotes_gpc по умолчанию имеет значение `on`, при этом функция addslashes() автоматически применяется ко всем данным GET, POST, и COOKIE. Не используйте addslashes() для данных, обработанных magic_quotes_gpc, чтобы избежать двойного экранирования. Для проверки состояния этой директивы используется get_magic_quotes_gpc().

Пример 1. Пример использования addslashes()

`<?php $str = "Is your name O'reilly?"; // выводит: Is your name O\'reilly? echo addslashes($str); ?>`

См. также описание функций stripslashes(), htmlspecialchars(), quotemeta() и get_magic_quotes_gpc().

add a note User Contributed Notes
addslashes
Adrian C
02-Mar-2007 06:06
`What happends when you add addslashes(addslashes($str))? This is not a good thing and it may be fixed:
function checkaddslashes($str){
if(strpos(str_replace("\'",""," $str"),"'")!=false)
return addslashes($str);
else
return $str;
}
checkaddslashes("aa'bb"); => aa\'bb
checkaddslashes("aa\'bb"); => aa\'bb
checkaddslashes("\'"); => \'
checkaddslashes("'"); => \'
Hope this will help you`
pulstar at ig dot com dot br
11-Sep-2006 07:50
`May it is better use the function mysql_real_escape_string instead of addslashes when inserting data into a MySQL database. Check it at:
http://www.php.net/manual/en/function.mysql-real-escape-string.php`
joechrz at gmail dot com
19-Aug-2006 05:36
`Here's an example of a function that prevents double-quoting, I'm surprised noone has put something like this up yet... (also works on arrays)
<?php
function escape_quotes($receive) {
if (!is_array($receive))
$thearray = array($receive);
else
$thearray = $receive;
foreach (array_keys($thearray) as $string) {
$thearray[$string] = addslashes($thearray[$string]);
$thearray[$string] = preg_replace("/[\\/]+/","/",$thearray[$string]);
}
if (!is_array($receive))
return $thearray[0];
else
return $thearray;
}
?>`
Picky
24-May-2006 12:55
`This function is deprecated in PHP 4.0, according to this article:
http://www.newsforge.com/article.pl?sid=06/05/23/2141246
Also, it is worth mentioning that PostgreSQL will soon start to block queries involving escaped single quotes using \ as the escape character, for some cases, which depends on the string's encoding. The standard way to escape quotes in SQL (not all SQL databases, mind you) is by changing single quotes into two single quotes (e.g, ' ' ' becomes ' '' ' for queries).
You should look into other ways for escaping strings, such as "mysql_real_escape_string" (see the comment below), and other such database specific escape functions.`
21-Jan-2006 11:59
`Probably good to take a look at http://us3.php.net/manual/en/function.mysql-real-escape-string.php .`
luciano at vittoretti dot com dot br
31-Oct-2005 03:18
`Note, this function wont work with mssql or access queries.
Use the function above (work with arrays too).
function addslashes_mssql($str){
if (is_array($str)) {
foreach($str AS $id => $value) {
$str[$id] = addslashes_mssql($value);
}
} else {
$str = str_replace("'", "''", $str);
}
return $str;
}
function stripslashes_mssql($str){
if (is_array($str)) {
foreach($str AS $id => $value) {
$str[$id] = stripslashes_mssql($value);
}
} else {
$str = str_replace("''", "'", $str);
}
return $str;
}`
thisisroot at gmail dot com
26-Sep-2005 09:30
`In response to Krasimir Slavov and Luiz Miguel Axcar:
There are several encoding schemes for inserting binary data into places it doesn't typically belong, such as databases and e-mail bodies. Check out the base64_encode() and convert_uuencode() functions for the details.`
Krasimir Slavov kkslavov at yahoo dot com
16-Sep-2005 11:51
`If you have problems with adding images or other binady data with addslashes() for php 4.3 >= use:
<?php
$search = array("\x00", "\x0a", "\x0d", "\x1a", "\x09");
$replace = array('\0', '\n', '\r', '\Z' , '\t');
$chrData .= str_replace($search, $replace, $Data );
?>
and put in your SQL field='$chrData' ! please remark quotes`
Luiz Miguel Axcar (lmaxcar at yahoo dot com dot br)
01-Sep-2005 06:16
`Hello,
If you are getting trouble to SGDB write/read HTML data, try to use this:
<?php
//from html_entity_decode() manual page
function unhtmlentities ($string) {
$trans_tbl =get_html_translation_table (HTML_ENTITIES );
$trans_tbl =array_flip ($trans_tbl );
return strtr ($string ,$trans_tbl );
}
//read from db
$content = stripslashes (htmlspecialchars ($field['content']));
//write to db
$content = unhtmlentities (addslashes (trim ($_POST['content'])));
//make sure result of function get_magic_quotes_gpc () == 0, you can get strange slashes in your content adding slashes twice
//better to do this using addslashes
$content = (! get_magic_quotes_gpc ()) ? addslashes ($content) : $content;
?>`
unsafed
30-Apr-2005 08:23
`addslashes does NOT make your input safe for use in a database query! It only escapes according to what PHP defines, not what your database driver defines. Any use of this function to escape strings for use in a database is likely an error - mysql_real_escape_string, pg_escape_string, etc, should be used depending on your underlying database as each database has different escaping requirements. In particular, MySQL wants \n, \r and \x1a escaped which addslashes does NOT do. Therefore relying on addslashes is not a good idea at all and may make your code vulnerable to security risks. I really don't see what this function is supposed to do.`
gv
06-Nov-2004 05:23
`Regarding the previous note using addslashes/stripslahes with regular expressions and databases it looks as if the purpose of these functions gets mixed.
addslahes encodes data to be sent to a database or something similar. Here you need addslashes because you send commands to the database as command strings that contain data and thus you have to escape characters that are special in the command language like SQL.
Therefore the use of addslahses on a regex does properly store the regex in the database.
stripslashes does the opposite: it decodes an addslashes encoded string. However, retrieving data from a database works differently: it does not go through some string interpretation because you actually retrieve your binary data in your variables. In other words: the data stored in your variable is the unmodified binary data that your database returned. You do not run stripslahes on data returned from a database. That way, the regexs are retrieved correctly, too.
This is different from other data exchange like urlencoded strings that you exchange with your browser. Here the data channel uses the same encodings in both directions: therefore you have to encode data to be sent and you have to decode data received.`
percy at rotteveel dot ca
19-Oct-2004 08:08
`Be very careful when using addslashes and stripslashes in combination with regular expression that will be stored in a MySQL database. Especially when the regular expression contain escape characters!
To store a regular expression with escape characters in a MySQL database you use addslashes. For example:
$l_reg_exp = addslashes( �[\x00-\x1F]� );
After this the variable $l_reg_exp will contain: [\\x00-\\x1F].
When you store this regular expression in a MySQL database, the regular expression in the database becomes [\x00-\x1F].
When you retrieve the regular expression from the MySQL database and apply the PHP function stripslashes(), the single backslashes will be gone!
The regular expression will become [x00-x1F] and your regular expression might not work!`
mark at hagers dot demon dot nl
27-Sep-2004 03:34
`I was stumped for a long time by the fact that even when using addslashes and stripslashes explicitly on the field values double quotes (") still didn't seem to show up in strings read from a database. Until I looked at the source, and realised that the field value is just truncated at the first occurrence of a double quote. the remainder of the string is there (in the source), but is ignored when the form is displayed and submitted.
This can easily be solved by replacing double quotes with "&quot;" when building the form. like this:
$fld_value = str_replace ( "\"", "&quot;", $src_string ) ;
The reverse replacement after the form submission is not necessary.`
hazy underscore fakie at ringwraith dot org
12-Jul-2003 11:23
`Note that when using addslashes() on a string that includes cyrillic characters, addslashes() totally mixes up the string, rendering it unusable.`
phil at internetprojectmanagers dot com
09-Apr-2003 06:46
`re: problem with mcrypt, addslashes and mysql
Here is my solution to the problem of characters from mcrypt creating issues with mysql calls (due to characters which aren't cleaned up by addslashes).
Solution: simply convert your encryption string to hex, then back to binary when you are ready to decrypt.
<?php
// ie.
$encrypted = addslashes($string);
$encrypted = bin2hex($encrypted);
// ... then:
$decrypted = hex2bin($encrypted);
$decrypted = stripslashes($decrypted);
// where hex2bin() is:
function hex2bin($hexdata) {
$bindata="";
for ($i=0;$i<strlen($hexdata);$i+=2) {
$bindata.=chr(hexdec(substr($hexdata,$i,2)));
}
return $bindata;
}
?>
One word of caution: this will increase the length of your initial data string, so you will need to increase the field length for your mysql database.
Cheers, Phil
PS. I knew that I'd eventually be able to give something back to the site!`
phil at internetprojectmanagers dot com
09-Apr-2003 04:47
`re: encryption, addslashes and mysql
Note that mcrypt encryption may add in an apostrophe from the ascii table which cannot be protected by addslashes. It may not even be on your keyboard.
Because encryption strings are random, you may not discover it unless you test (or stumble?) on the correct sequence which inserts an apostrophe in the encrypted string.
This means that testing is even more important where encryption is concerned. If I create a solution I'll post it here.
Phil`
steve at teamITS dot com
18-Jan-2003 05:53
`For thelogrus, my testing shows the opposite--that a slashed string is stored correctly by MySQL. Consider
insert into test (field1) values ('test\'test')
...which is stored as "test'test". If you were posting "Sir'Weaser" from a form to your script and have magic_quotes_gpc on, then the string is slashed already so if you run addslashes() again you will be entering "Sir\\'Weaser" into MySQL. In that case "Sir\'Weaser" would be the correct output.
In summary, addslashes() is not necessary if magic_quotes_gpc is on.`
mike at gyrate dot org
13-Jan-2003 02:05
`[Editor's note: See also the php.ini configuration magic_quotes_sybase at the URL http://www.php.net/manual/en/ref.sybase.php]
please note that addslashes will NOT work with mssql, since mssql does not use the backslash character as an escape mechanism. just double your quotes instead. or use this:
<?php
function mssql_addslashes($data) {
$data = str_replace("'", "''", $data);
return $data;
}
?>`
hoskerr at nukote dot com
12-Nov-2002 03:16
`Beware of using addslashes() on input to the serialize() function. serialize() stores strings with their length; the length must match the stored string or unserialize() will fail.
Such a mismatch can occur if you serialize the result of addslashes() and store it in a database; some databases (definitely including PostgreSQL) automagically strip backslashes from "special" chars in SELECT results, causing the returned string to be shorter than it was when it was serialized.
In other words, do this...
<?php
$string="O'Reilly";
$ser=serialize($string); # safe -- won't count the slash
$result=addslashes($ser);
?>
...and not this...
<?php
$string="O'Reilly";
$add=addslashes($string); # RISKY! -- will count the slash
$result=serialize($add);
?>
In both cases, a backslash will be added after the apostrophe in "O'Reilly"; only in the second case will the backslash be included in the string length as recorded by serialize().
[Note to the maintainers: You may, at your option, want to link this note to serialize() as well as to addslashes(). I'll refrain from doing such cross-posting myself...]`
php at slamb dot org
30-Oct-2002 10:48
`spamdunk at home dot com, your way is dangerous on PostgreSQL (and presumably MySQL). You're quite correct that ANSI SQL specifies using ' to escape, but those databases also support \ for escaping (in violation of the standard, I think). Which means that if they pass in a string that includes a "\'", you expand it to "\'''" (an escaped quote followed by a non-escaped quote. WRONG! Attackers can execute arbitrary SQL to drop your tables, make themselves administrators, whatever they want.)
The best way to be safe and correct is to:
- don't use magic quotes; this approach is bad. For starters, that's making the assumption that you will be using your input in a database query, which is arbitrary. (Why not escape all "<"s with "&lt;"s instead? Cross-site scripting attacks are quite common as well.) It's better to set up a way that does whatever escaping is correct for you when you use it, as below:
- when inserting into the database, use prepared statements with placeholders. For example, when using PEAR DB:
<?php
$stmt = $dbh->prepare('update mb_users set password = ? where username = ?');
$dbh->execute($stmt, array('12345', 'bob'));
?>
Notice that there are no quotes around the ?s. It handles that for you automatically. It's guaranteed to be safe for your database. (Just ' on oracle, \ and ' on PostgreSQL, but you don't even have to think about it.)
Plus, if the database supports prepared statements (the soon-to-be-released PostgreSQL 7.3, Oracle, etc), several executes on the same prepare can be faster, since it can reuse the same query plan. If it doesn't (MySQL, etc), this way falls back to quoting code that's specifically written for your database, avoiding the problem I mentioned above.
(Pardon my syntax if it's off. I'm not really a PHP programmer; this is something I know from similar things in Java, Perl, PL/SQL, Python, Visual Basic, etc.)`
guy_AT_datalink_DOT_net_DOT_au
30-Mar-2002 01:58
`If you're trying to escape quotes in a javascript event as such:
<img src="foo.gif" OnMouseOver="alert('<? print $myString ?>')">
It helps to perform this first:
$myString = str_replace("'", "\'", $myString);
$myString = str_replace('"', "'+String.fromCharCode(34)+'", $myString);`
hybrid at n0spam dot pearlmagik dot com
08-May-2001 10:46
`Remember to slash underscores (_) and percent signs (%), too, if you're going use the LIKE operator on the variable or you'll get some unexpected results.`
php at NO_SPAMj-w3 dot com
02-Apr-2001 03:18
`As mentioned, magic_quotes_gpc automatically adds slashes to POST and GET data and these slashes don't go in the database. BUT, be careful of this. If you have a form with an error check, make sure you strip the slashes if your form remembers the OK fields, so the user doesn't view these automagically added slashes.`
spamdunk at home dot com
06-Mar-2001 01:12
`FYI, Quoting the single quote (') as ('') is not an Oracle stle, or a Sybase style, or any other vendor-specific style. It is the ANSI SQL (i.e. SQL standard) style.
Using blackslahes to escape characters is a proprietary extension that some databases have. If you want your SQL to be portable across databases, don't use it.
For example (on PostgreSQL):
=> create table t (s varchar(64));
CREATE
=> insert into t values ('one''two"three''');
INSERT 206474 1
wapkey=> select * from t;
s
----------------
one'two"three'
(1 row)
... as expected, as per the standard.`
add a note
bin2hex addcslashes

Last updated: Sat, 27 Jan 2007
show source | credits | stats | sitemap | contact | advertising | mirror sites
Copyright © 2001-2007 The PHP Group
All rights reserved.
This mirror generously provided by: Yahoo! Inc.
Last updated: Sat Mar 10 09:32:46 2007 PST