<!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>Logs in to an FTP connection</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-get.html">ftp_get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-mdtm.html">ftp_mdtm</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-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>
<div class="refsect1 description" id="refsect1-function.ftp-login-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ftp_login</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">$username</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</code></span>
)</div>
<p class="para rdfs-comment">
Logs in to the given FTP stream.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-login-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">username</code></em></span>
<dd>
<p class="para">
The username (<em>USER</em>).
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">password</code></em></span>
<dd>
<p class="para">
The password (<em>PASS</em>).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-login-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.
If login fails, PHP will also throw a warning.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ftp-login-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4286">
<p><strong>Example #1 <span class="function"><strong>ftp_login()</strong></span> example</strong></p>
<div class="example-contents">
<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>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-get.html">ftp_get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-mdtm.html">ftp_mdtm</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>
