php-doc-en/reference/mysql/functions/mysql-real-escape-string.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/mysql.xml, last change in rev 1.100 -->
  <refentry id="function.mysql-real-escape-string">
   <refnamediv>
    <refname>mysql_real_escape_string</refname>
    <refpurpose>
     Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>mysql_real_escape_string</methodname>
      <methodparam><type>string</type><parameter>unescaped_string</parameter></methodparam>
      <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function will escape special characters in the
     <parameter>unescaped_string</parameter>, taking into account the current
     charset of the connection so that it is safe to place it in a
     <function>mysql_query</function>. 
    </para>
    <note>
     <simpara>
      <function>mysql_real_escape_string</function> does not escape
      <literal>%</literal> and <literal>_</literal>.
     </simpara>
    </note>
    <para>
     <example>
      <title><function>mysql_real_escape_string</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
$link = mysql_connect('localhost', 'mysql_user', 'mysql_password');
if (!$link) {
    die('Could not connect: ' . mysql_error());
}
$item = "Zak's and Derick's Laptop";
$escaped_item = mysql_real_escape_string($item, $link);
printf("Escaped string: %s\n", $escaped_item);
?>
]]>
      </programlisting>
      <para>
       The above example would produce the following output:
      </para>
      <screen>
<![CDATA[
Escaped string: Zak\'s and Derick\'s Laptop
]]>
      </screen>
     </example>
    </para>
    <para>
     See also
     <function>mysql_escape_string</function>,
     <function>mysql_client_encoding</function>,
     <function>addslashes</function>, and the 
     <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>
     directive.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->