<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Sends a SITE command to the server</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-set-option.html">ftp_set_option</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-size.html">ftp_size</a></div>
<div class="up"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ftp-site" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_site</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ftp_site</span> — <span class="dc-title">Sends a SITE command to the server</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftp-site-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ftp_site</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ftp_stream</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$command</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>ftp_site()</strong></span> sends the given <em>SITE</em>
command to the FTP server.
</p>
<p class="para">
<em>SITE</em> commands are not standardized, and vary from server
to server. They are useful for handling such things as file permissions and
group membership.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-site-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">ftp_stream</code></em></span>
<dd>
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">command</code></em></span>
<dd>
<p class="para">
The SITE command. Note that this parameter isn't escaped so there may
be some issues with filenames containing spaces and other characters.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-site-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ftp-site-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4306">
<p><strong>Example #1 Sending a SITE command to an ftp server</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Connect to FTP server<br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'ftp.example.com'</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$conn</span><span style="color: #007700">) die(</span><span style="color: #DD0000">'Unable to connect to ftp.example.com'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Login as "user" with password "pass"<br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">ftp_login</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">'user'</span><span style="color: #007700">, </span><span style="color: #DD0000">'pass'</span><span style="color: #007700">)) die(</span><span style="color: #DD0000">'Error logging into ftp.example.com'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Issue: "SITE CHMOD 0600 /home/user/privatefile" command to ftp server<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">ftp_site</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">'CHMOD 0600 /home/user/privatefile'</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Command executed successfully.\n"</span><span style="color: #007700">;<br />} else {<br /> die(</span><span style="color: #DD0000">'Command failed.'</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ftp-site-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ftp-raw.html" class="function" rel="rdfs-seeAlso">ftp_raw()</a> - Sends an arbitrary command to an FTP server</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-set-option.html">ftp_set_option</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-size.html">ftp_size</a></div>
<div class="up"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
