ftp_get
PHP 4, PHP 5, PHP 7, PHP 8
ftp_get - Downloads a file from the FTP server
Manual
ftp_get(
FTP\Connection$ftp,
string$local_filename,
string$remote_filename,
[int$mode = FTP_BINARY],
[int$offset = 0]
): 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_ASCII or FTP_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. |