Source of: /manual/en/function.escapeshellarg.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.exec.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.escapeshellarg.php',
1 => 'escapeshellarg',
),
'up' =>
array (
0 => 'ref.exec.php',
1 => 'Program execution Functions',
),
'prev' =>
array (
0 => 'ref.exec.php',
1 => 'Program execution Functions',
),
'next' =>
array (
0 => 'function.escapeshellcmd.php',
1 => 'escapeshellcmd',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.escapeshellarg" class="refentry">
<div class="refnamediv">
<h1 class="refname">escapeshellarg</h1>
<p class="verinfo">(PHP 4 >= 4.0.3, PHP 5)</p><p class="refpurpose"><span class="refname">escapeshellarg</span> — <span class="dc-title">Escape a string to be used as a shell argument</span></p>
</div>
<a name="function.escapeshellarg.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>escapeshellarg</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$arg</tt></span>
)</div>
<p class="para rdfs-comment">
<b>escapeshellarg()</b> 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 <a href="function.exec.php" class="function">exec()</a>, <a href="function.system.php" class="function">system()</a> and the
<a href="language.operators.execution.php" class="link">backtick operator</a>.
</p>
</div>
<a name="function.escapeshellarg.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">arg</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The argument that will be escaped.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.escapeshellarg.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The escaped string.
</p>
</div>
<a name="function.escapeshellarg.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>escapeshellarg()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />system</span><span style="color: #007700">(</span><span style="color: #DD0000">'ls '</span><span style="color: #007700">.</span><span style="color: #0000BB">escapeshellarg</span><span style="color: #007700">(</span><span style="color: #0000BB">$dir</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.escapeshellarg.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.escapeshellcmd.php" class="function" rel="rdfs-seeAlso">escapeshellcmd()</a> - Escape shell metacharacters</li>
<li class="member"><a href="function.exec.php" class="function" rel="rdfs-seeAlso">exec()</a> - Execute an external program</li>
<li class="member"><a href="function.popen.php" class="function" rel="rdfs-seeAlso">popen()</a> - Opens process file pointer</li>
<li class="member"><a href="function.system.php" class="function" rel="rdfs-seeAlso">system()</a> - Execute an external program and display the output</li>
<li class="member"><a href="language.operators.execution.php" class="link">backtick operator</a></li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
