PHP ftp_get( ) Function

The ftp_get() function is used to download a file from the FTP server. The ftp_get() function retrieves a remote file from the FTP server, and saves it into a local file. This function was introduced in PHP 4.

Syntax:

bool ftp_get ( resource $ftp_stream , string $local_file , string $remote_file [, int $mode = FTP_BINARY [, int $resumepos = 0 ]] );

Parameter	Description	Is compulsory
ftp_stream	The link identifier of the FTP connection.	compulsory
local_file	The local file path(will be overwritten if the file already exists).	compulsory
remote_file	The remote file path.	compulsory
mode	The transfer mode. Must be either FTP_ASCII or FTP_BINARY	compulsory
resumepos	The position in the remote file to start downloading from	Optional

Returns

The ftp_get() function returns true on success or false on failure.

Example 1

<?php
// define some variables
$local_file = 'myfile.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_file
if (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 connection
ftp_close($conn_id);
?>

Explanation

In the above example, by using ftp_get() function we can download a file from ftp server to local file.

Example 2

<?php
// connect and login to FTP server
$ftp_server = "ftp.javatpoint.com";
$ftp_conn = ftp_connect($ftp_server) or die("Could not connect to $ftp_server");
$login = ftp_login($ftp_conn, $ftp_username, $ftp_userpass);
$local_file = "myfile.zip";
$server_file = "yourfile.zip";
// download server file
if (ftp_get($ftp_conn, $local_file, $server_file, FTP_ASCII))
	{
echo "Successfully written to $local_file.";
}
else
{
echo "Error downloading $server_file.";
	}
// close connection
ftp_close($ftp_conn);
?>

Explanation

In the above example, by using ftp_get() we can download the file from FTP server and saves into local space.

Example 3

<?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_file
if (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 connection
ftp_close($conn_id);
?>