PHP - Manual: ftp_get

2025-10-31

ftp_get

(PHP 4, PHP 5, PHP 7, PHP 8)

ftp_get — 从 FTP 服务器上下载文件

说明

ftp_get(
    FTP\Connection $ftp,
    string $local_filename,
    string $remote_filename,
    int $mode = FTP_BINARY,
    int $offset = 0
): bool

ftp_get() 函数用来下载 FTP 服务器上指定的文件并保存为本地文件。

参数

ftp: FTP\Connection 实例。
local_filename: 文件本地的路径（如果文件已经存在，则会被覆盖）。
remote_filename: 文件的远程路径。
mode: 传送模式。只能为 (文本模式) FTP_ASCII 或 (二进制模式) FTP_BINARY 中的其中一个。
offset: 从远程文件的这个位置继续下载。

返回值

成功时返回 true，或者在失败时返回 false。

更新日志

版本	说明
8.1.0	现在 `ftp` 参数接受 FTP\Connection 实例，之前接受 resource。
7.3.0	`mode` 参数现在可选。以前强制要求。

示例

示例 #1 ftp_get() 示例

<?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);

?>

参见

ftp_pasv() - 返回当前 FTP 被动模式是否打开
ftp_fget() - 从 FTP 服务器上下载文件并保存到本地已打开的文件中
ftp_nb_get() - 从 FTP 服务器上获取文件并写入本地文件（non-blocking）
ftp_nb_fget() - 从 FTP 服务器获取文件并写入到一个打开的文件（非阻塞）

发现了问题？

了解如何改进此页面 • 提交拉取请求 • 报告一个错误

＋添加备注

用户贡献的备注 14 notes

down

CuDi ¶

15 years ago

I tried to ftp a 7mb file today off my webserver.

I copied this example directly and it told me.

Port command successful
"there was a problem"

I thought it was because of the size.
But I guessed it might be cause of my firewall.

So I made the ftp connection passive:

<?PHP

...
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
ftp_pasv($conn_id, true);

?>

Ran the script again & it worked fine.

Hope this helps someone

down

bob at notallhere dot com ¶

11 years ago

Don't want to use an intermediate file?  Use 'php://output' as the filename and then capture the output using output buffering.

ob_start();
$result = ftp_get($ftp, "php://output", $file, FTP_BINARY);
$data = ob_get_contents();
ob_end_clean();

Don't forget to check $result to make sure there wasn't an error.  After that, manipulate the $data variable however you want.

down

ramiro at qusarcr dot com ¶

22 years ago

Keep in mind that ftp_get will overwrite the file on your local machine if it has the same name.

down

anomie at users dot sf dot net ¶

18 years ago

Why there isn't an "ftp_get_contents" function, I don't know. It takes a little work to emulate one, but it's doable.
<?php
function ftp_get_contents($ftp_stream, $remote_file, $mode, $resume_pos=null){
$pipes=stream_socket_pair(STREAM_PF_UNIX, STREAM_SOCK_STREAM, STREAM_IPPROTO_IP);
    if($pipes===false) return false;
    if(!stream_set_blocking($pipes[1], 0)){
fclose($pipes[0]); fclose($pipes[1]);
        return false;
    }
$fail=false;
$data='';
    if(is_null($resume_pos)){
$ret=ftp_nb_fget($ftp_stream, $pipes[0], $remote_file, $mode);
    } else {
$ret=ftp_nb_fget($ftp_stream, $pipes[0], $remote_file, $mode, $resume_pos);
    }
    while($ret==FTP_MOREDATA){
        while(!$fail && !feof($pipes[1])){
$r=fread($pipes[1], 8192);
            if($r==='') break;
            if($r===false){ $fail=true; break; }
$data.=$r;
        }
$ret=ftp_nb_continue($ftp_stream);
    }
    while(!$fail && !feof($pipes[1])){
$r=fread($pipes[1], 8192);
        if($r==='') break;
        if($r===false){ $fail=true; break; }
$data.=$r;
    }
fclose($pipes[0]); fclose($pipes[1]);
    if($fail || $ret!=FTP_FINISHED) return false;
    return $data;
}
?>

Something similar would work to write a ftp_put_contents function, too.

down

Nate from ruggfamily.com ¶

16 years ago

Here's a quick function that figures out the correct mode to use based on a file's extension.

<?php
function get_ftp_mode($file)
{    
$path_parts = pathinfo($file);

    if (!isset($path_parts['extension'])) return FTP_BINARY;
    switch (strtolower($path_parts['extension'])) {
        case 'am':case 'asp':case 'bat':case 'c':case 'cfm':case 'cgi':case 'conf':
        case 'cpp':case 'css':case 'dhtml':case 'diz':case 'h':case 'hpp':case 'htm':
        case 'html':case 'in':case 'inc':case 'js':case 'm4':case 'mak':case 'nfs':
        case 'nsi':case 'pas':case 'patch':case 'php':case 'php3':case 'php4':case 'php5':
        case 'phtml':case 'pl':case 'po':case 'py':case 'qmail':case 'sh':case 'shtml':
        case 'sql':case 'tcl':case 'tpl':case 'txt':case 'vbs':case 'xml':case 'xrc':
            return FTP_ASCII;
    }
    return FTP_BINARY;
}

// sample usage
ftp_get($conn_id, $local_file, $server_file, get_ftp_mode($server_file));
?>

down

mroerick at gmx dot net ¶

15 years ago

ftp_sync is a way to walk the directory structure on the server and copy every directory and file to the same location locally.


<?php

$ftp_server = "ftp.example.com";

$conn_id = ftp_connect ($ftp_server)

    or die("Couldn't connect to $ftp_server"); 


$login_result = ftp_login($conn_id, "user", "pass");

if ((!$conn_id) || (!$login_result))

    die("FTP Connection Failed");


ftp_sync ("DirectoryToCopy");    // Use "." if you are in the current directory


ftp_close($conn_id);  


// ftp_sync - Copy directory and file structure

function ftp_sync ($dir) {


    global $conn_id;


    if ($dir != ".") {

        if (ftp_chdir($conn_id, $dir) == false) {

            echo ("Change Dir Failed: $dir<BR>\r\n");

            return;

        }

        if (!(is_dir($dir)))

mkdir($dir);

chdir ($dir);

    }


$contents = ftp_nlist($conn_id, ".");

    foreach ($contents as $file) {


        if ($file == '.' || $file == '..')

            continue;


        if (@ftp_chdir($conn_id, $file)) {

ftp_chdir ($conn_id, "..");

ftp_sync ($file);

        }

        else

ftp_get($conn_id, $file, $file, FTP_BINARY);

    }


ftp_chdir ($conn_id, "..");

chdir ("..");


}

?>

down

Aditya P dot Bhatt (adityabhai at gmail dot com) ¶

16 years ago

<?php
// define some variables
$folder_path = "YOUR FOLDER PATH"; 
$local_file = "LOCAL FILE PATH";
$server_file = "SERVER FILE PATH";

//-- Connection Settings
$ftp_server = "IP ADDRESS"; // Address of FTP server.
$ftp_user_name = "USERNAME"; // Username
$ftp_user_pass = "PASSWORD"; // Password
        #$destination_file = "FILEPATH"; 

        // 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);
?>

down

mpatnode at yahoo dot com ¶

6 years ago

Note that PHP still defaults to FTP active mode by default, which is almost never used anymore since the creation of firewalls.   Don't forget to add a ftp_pasv($conn, true) after your ftp_login.

down

anomie at users dot sf dot net ¶

18 years ago

Crud. The _nb_ only refers to reading from the ftp server, and the buffer in the socket pair is only about 364 bytes. So it doesn't work for files larger than that size.

down

thivierr at telus dot net ¶

21 years ago

If you previously downloaded a file before (like a huge web log), and just want to get the remaining portion, do this:

$local_file_size = filesize($local_file_path);
$get_result = ftp_get($conn_id, $local_file_path, $remote_file_path, FTP_BINARY, $local_file_size);

This same code works regardless of wether the local file exists already or not.  You should first test to make sure the local file is not bigger than the remote file.

down

-1

administrator at gesoft dot org ¶

18 years ago

Hello everybody,

If someone will try to download files to the same local file (some temporary file), like shown here:

<?php
foreach ($files as $key=>$path) {
... 
$result = ftp_get($ftpConnId, 'temp.tmp', $path, FTP_BINARY);
...
}
?>

please take in consideration the fact that you will have big problems with downloading (getting) hole files. In other words ‘temp.tmp’ file always will have the same size equal to first downloaded file despite the real size of downloading file. I have not idea what is the reason!

If someone will think that problem is just in getting proper file size (which you will get using filssize() function) he will be mistaken. The download file’s size is not equal to source file’s size materially, that means fflush() function will not solve the problem (I have tried this as well).

Finally the solution was founded: before downloading a file you will need to delete local file if such exist (‘temp.tmp’). So working code will look like:

<?php
foreach ($files as $key=>$path) {
... 
  if (file_exists('temp.tmp')) {
unlink('temp.tmp');
  }
$result = ftp_get($ftpConnId, 'temp.tmp', $path, FTP_BINARY);
...
}
?>

Good luck in scripting :-)

Vitali Simsive

down

-1

miki at epoch dot co dot il ¶

12 years ago

If you ran the example and see that it fail after 90sec (timeout).

Then try adding:
<?php
ftp_pasv($ftp_conn, true);
?>

down

-2

corey-holzer at nyc dot rr dot com ¶

21 years ago

The zero size file is not a side effect.  When the ftp_get starts the first thing it does is to create the inode/file which it will stream the data too and that is a zero size file with the nname you specified for the local file.  When the download fails it leaves the file in place.

down

-3

scott dot chu at udngroup dot com ¶

8 years ago

I'd suggest use ftp_fget() instead of ftp_get() since the latter only return TRUE or FALSE and there's no obvious way to get the cause of failure.

   Using ftp_fget,  you have to pass a file handle as local file, so you have to do fopen() first. By way of this, you can find 'Permission Denied' problem when call fopen(). If you use ftp_get(), there's no way to find this error cause.

   In my case, I run httpd using 'nobody' and I create ftp local folder using 'haha'. It tooks me long time to find the 'Permission Denied' problem at that time since  I use ftp_get() then.

＋添加备注

官方地址：https://www.php.net/manual/en/function.ftp-get.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言开发编程 Linux 科技 Elasticsearch HTML/CSS/XML 面试数据库网络 JAVA NoSQL C/C++ Golang 操作系统 Git 算法正则表达式 Redis 互联网 MySql 软件运维 JavaScript 国际架构设计 Mac OS Excel TCP/IP Windows Oracle Socket Vim VR MongoDB 运营 Python MemCache 商业硬件电子娱乐设计摄影 nginx WordPress 游戏 HTTP 团建数码电器 Docker

php7.3 使用 PDO_DM 扩展连接 DM8 中文乱码 PhpStorm中PHP注释的规范指南使用PHPWord将docx文件转换为html格式 docker-compose启动nginx与php-fpm laravel查看orm生成的sql PHPStorm ESC 会退出命令行 composer install参数 laravel orm中DB::insert方法导致内存泄漏的问题解决方法 php7 安装fileinfo扩展 adodb手册 ADORecordSet对象常用的php ADODB使用方法集锦 ADOConnection 公用函数利用php soap实现web service adodb连接mysql多个数据库的问题 mysql面试题 [PHP] inet_pton/inet_ntop IP地址转换函数 PHP json解析（json_decode）页面工具 PHP7添加redis扩展 PHP注释规范

略微加速

PHP官方手册 - 互联网笔记

ftp_get

说明

参数

返回值

更新日志

示例

参见

发现了问题？

用户贡献的备注 14 notes