Php/docs/function.ftp-get
ftp_get
(PHP 4, PHP 5, PHP 7)
ftp_get — Downloads a file from the FTP server
Description
ftp_get
( resource $ftp_stream
, string $local_file
, string $remote_file
[, int $mode
= FTP_BINARY
[, int $resumepos
= 0
]] ) : bool
ftp_get() retrieves a remote file from the FTP server, and saves it into a local file.
Parameters
ftp_stream
- The link identifier of the FTP connection.
local_file
- The local file path (will be overwritten if the file already exists).
remote_file
- The remote file path.
mode
- The transfer mode. Must be either
FTP_ASCII
orFTP_BINARY
. resumepos
- The position in the remote file to start downloading from.
Return Values
Returns TRUE
on success or FALSE
on failure.
Changelog
Version | Description |
---|---|
7.3.0 | The mode parameter is now optional. Formerly it
has been mandatory. |
Examples
Example #1 ftp_get() example
<?php// define some variables$local_file = 'local.zip';$server_file = 'server.zip';// set up basic connection$conn_id = ftp_connect($ftp_server);// login with username and password$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);// try to download $server_file and save to $local_fileif (ftp_get($conn_id, $local_file, $server_file, FTP_BINARY)) { echo "Successfully written to $local_file\n";} else { echo "There was a problem\n";}// close the connectionftp_close($conn_id);?>
See Also
- ftp_pasv() - Turns passive mode on or off
- ftp_fget() - Downloads a file from the FTP server and saves to an open file
- ftp_nb_get() - Retrieves a file from the FTP server and writes it to a local file (non-blocking)
- ftp_nb_fget() - Retrieves a file from the FTP server and writes it to an open file (non-blocking)