mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
7f569e1f17
Patch contributed by Sobak <msobaczewski@gmail.com>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350655 c90b9560-bf6c-de11-be94-00142212c4b1
127 lines
3.2 KiB
XML
127 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.mysql-escape-string" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>mysql_escape_string</refname>
|
|
<refpurpose>Escapes a string for use in a mysql_query</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<warning>
|
|
&mysql.alternative.note.4-3-0;
|
|
<simplelist role="alternatives">
|
|
<member><function>mysqli_escape_string</function></member>
|
|
<member><methodname>PDO::quote</methodname></member>
|
|
</simplelist>
|
|
</warning>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>mysql_escape_string</methodname>
|
|
<methodparam><type>string</type><parameter>unescaped_string</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function will escape the <parameter>unescaped_string</parameter>,
|
|
so that it is safe to place it in a <function>mysql_query</function>.
|
|
This function is deprecated.
|
|
</para>
|
|
<para>
|
|
This function is identical to <function>mysql_real_escape_string</function>
|
|
except that <function>mysql_real_escape_string</function> takes a
|
|
connection handler and escapes the string according to the current
|
|
character set. <function>mysql_escape_string</function> does not take a
|
|
connection argument and does not respect the current charset setting.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>unescaped_string</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The string that is to be escaped.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the escaped string.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>mysql_escape_string</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$item = "Zak's Laptop";
|
|
$escaped_item = mysql_escape_string($item);
|
|
printf("Escaped string: %s\n", $escaped_item);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Escaped string: Zak\'s Laptop
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
<function>mysql_escape_string</function> does not escape
|
|
<literal>%</literal> and <literal>_</literal>.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>mysql_real_escape_string</function></member>
|
|
<member><function>addslashes</function></member>
|
|
<member>The <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link> directive.</member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|