Source of: /manual/en/function.ftp-login.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ftp.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ftp-login.php',
1 => 'ftp_login',
),
'up' =>
array (
0 => 'ref.ftp.php',
1 => 'FTP Functions',
),
'prev' =>
array (
0 => 'function.ftp-get.php',
1 => 'ftp_get',
),
'next' =>
array (
0 => 'function.ftp-mdtm.php',
1 => 'ftp_mdtm',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.ftp-login" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_login</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ftp_login</span> — <span class="dc-title">Logs in to an FTP connection</span></p>
</div>
<a name="function.ftp-login.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>ftp_login</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$ftp_stream</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$username</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$password</tt></span>
)</div>
<p class="para rdfs-comment">
Logs in to the given FTP stream.
</p>
</div>
<a name="function.ftp-login.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">ftp_stream</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">username</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The username (<i>USER</i>).
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">password</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The password (<i>PASS</i>).
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.ftp-login.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
If login fails, PHP will also throw a warning.
</p>
</div>
<a name="function.ftp-login.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>ftp_login()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> <br />$ftp_server </span><span style="color: #007700">= </span><span style="color: #DD0000">"ftp.example.com"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$ftp_user </span><span style="color: #007700">= </span><span style="color: #DD0000">"foo"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$ftp_pass </span><span style="color: #007700">= </span><span style="color: #DD0000">"bar"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// set up a connection or die<br /></span><span style="color: #0000BB">$conn_id </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$ftp_server</span><span style="color: #007700">) or die(</span><span style="color: #DD0000">"Couldn't connect to </span><span style="color: #0000BB">$ftp_server</span><span style="color: #DD0000">"</span><span style="color: #007700">); <br /><br /></span><span style="color: #FF8000">// try to login<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_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_pass</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Connected as </span><span style="color: #0000BB">$ftp_user</span><span style="color: #DD0000">@</span><span style="color: #0000BB">$ftp_server</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">"Couldn't connect as </span><span style="color: #0000BB">$ftp_user</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// close the connection<br /></span><span style="color: #0000BB">ftp_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">); <br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
</div><?php manual_footer(); ?>
