(PHP 4, PHP 5, PHP 7, PHP 8)
ftp_get — Downloads a file from the FTP server
$ftp
,$local_filename
,$remote_filename
,$mode
= FTP_BINARY
,$offset
= 0ftp_get() retrieves a remote file from the FTP server, and saves it into a local file.
ftp
An FTP\Connection instance.
local_filename
The local file path (will be overwritten if the file already exists).
remote_filename
The remote file path.
mode
The transfer mode. Must be either FTP_ASCII
or
FTP_BINARY
.
offset
The position in the remote file to start downloading from.
Returns true
on success or false
on failure.
Version | Description |
---|---|
8.1.0 |
The ftp parameter expects an FTP\Connection
instance now; previously, a resource was expected.
|
7.3.0 |
The mode parameter is now optional. Formerly it
has been mandatory.
|
Example #1 ftp_get() example
<?php
// define some variables
$local_file = 'local.zip';
$server_file = 'server.zip';
// set up basic connection
$ftp = ftp_connect($ftp_server);
// login with username and password
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);
// try to download $server_file and save to $local_file
if (ftp_get($ftp, $local_file, $server_file, FTP_BINARY)) {
echo "Successfully written to $local_file\n";
} else {
echo "There was a problem\n";
}
// close the connection
ftp_close($ftp);
?>