ftp_get
(PHP 4, PHP 5, PHP 7, PHP 8)
ftp_get — Downloads a file from the FTP server
Description
ftp_get(
FTP\Connection
string
string
int
int
): bool
FTP\Connection
$ftp,string
$local_filename,string
$remote_filename,int
$mode = FTP_BINARY,int
$offset = 0): bool
ftp_get() retrieves a remote file from the FTP server, and saves it into a local file.
Parameters
-
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_ASCIIorFTP_BINARY. -
offset -
The position in the remote file to start downloading from.
Return Values
Returns true on success or false on failure.
Changelog
| 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.
|
Examples
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);
?>
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)
Here you can write a comment
There are no comments available yet.
