mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
8cdc6621f9
- array functions - datetime functions - mbstring functions - strings functions - var functions - xml functions - json functions
122 lines
3.1 KiB
XML
122 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.addslashes" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>addslashes</refname>
|
|
<refpurpose>Quote string with slashes</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>addslashes</methodname>
|
|
<methodparam><type>string</type><parameter>string</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns a string with backslashes added before characters that need to be
|
|
escaped. These characters are:
|
|
<simplelist>
|
|
<member>single quote (<literal>'</literal>)</member>
|
|
<member>double quote (<literal>"</literal>)</member>
|
|
<member>backslash (<literal>\</literal>)</member>
|
|
<member>NUL (the NUL byte)</member>
|
|
</simplelist>
|
|
</para>
|
|
<para>
|
|
A use case of <function>addslashes</function> is escaping the aforementioned
|
|
characters in a string that is to be evaluated by PHP:
|
|
<informalexample>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$str = "O'Reilly?";
|
|
eval("echo '" . addslashes($str) . "';");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
<para>
|
|
The <function>addslashes</function> is sometimes incorrectly used to try to prevent
|
|
<link linkend="security.database.sql-injection">SQL Injection</link>. Instead,
|
|
database-specific escaping functions and/or prepared statements should be used.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>string</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The string 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>An <function>addslashes</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$str = "Is your name O'Reilly?";
|
|
|
|
// Outputs: Is your name O\'Reilly?
|
|
echo addslashes($str);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>stripcslashes</function></member>
|
|
<member><function>stripslashes</function></member>
|
|
<member><function>addcslashes</function></member>
|
|
<member><function>htmlspecialchars</function></member>
|
|
<member><function>quotemeta</function></member>
|
|
<member><function>get_magic_quotes_gpc</function></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
|
|
-->
|