php-doc-en/reference/exec/functions/escapeshellarg.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/exec.xml, last change in rev 1.8 -->
  <refentry id="function.escapeshellarg">
   <refnamediv>
    <refname>escapeshellarg</refname>
    <refpurpose>Escape a string to be used as a shell argument</refpurpose>
   </refnamediv>
   <refsect1>
    &reftitle.description;
     <methodsynopsis>
      <type>string</type><methodname>escapeshellarg</methodname>
      <methodparam><type>string</type><parameter>arg</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>escapeshellarg</function> adds single quotes around a string
     and quotes/escapes any existing single quotes allowing you to pass a
     string directly to a shell function and having it be treated as a single
     safe argument.  This function should be used to escape individual
     arguments to shell functions coming from user input.  The shell functions
     include <function>exec</function>, <function>system</function> and the 
     <link linkend="language.operators.execution">backtick operator</link>. 
     A standard use would be:</para>
    <para>
     <informalexample>
      <programlisting role="php">
<![CDATA[
<?php
system('ls '.escapeshellarg($dir));
?>
]]>
      </programlisting>
     </informalexample>
    </para>
    <para>
     See also <function>escapeshellcmd</function>, <function>exec</function>,
     <function>popen</function>, <function>system</function>, and the <link
     linkend="language.operators.execution">backtick operator</link>.
    </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
-->