PHPのftp_nlist()関数とは？FTPサーバーのファイル一覧を取得する方法

ftp_nlist()関数は、FTPサーバー上の指定したディレクトリ内に存在するファイルの一覧を配列として返すPHPの組み込み関数です。FTP接続を利用してリモートサーバー内のファイル構成を確認したい場合に非常に便利な関数です。

基本構文

ftp_nlist()関数の書式は以下のとおりです。

ftp_nlist(con, dir);

パラメータ

• con − ftp_connect()で確立したFTP接続のリソース（接続ID）を指定します。

• dir − ファイル一覧を取得したいディレクトリのパスを指定します。カレントディレクトリを対象にする場合は「.」を指定します。

戻り値

ftp_nlist()関数は、処理が成功した場合にファイル名の配列を返します。失敗した場合にはFALSEを返します。

使用例

以下は、FTPサーバーに接続し、カレントディレクトリ内のファイル一覧を取得するサンプルコードです。

<?php
    $ftp_server = "192.168.0.4";
    $ftp_user = "tim";
    $ftp_pass = "wthbn#@121";

    // FTPサーバーへ接続
    $con = ftp_connect($ftp_server) or die("Could not connect to $ftp_server");

    // ログイン
    $login = ftp_login($con, $ftp_user, $ftp_pass);

    // カレントディレクトリのファイル一覧を取得
    $list = ftp_nlist($con, ".");

    // 結果を出力
    var_dump($list);

    // 接続を閉じる
    ftp_close($con);
?>

コードの解説

1. ftp_connect()でFTPサーバーに接続します。接続に失敗した場合はdie()によってエラーメッセージを表示して処理を終了します。
2. ftp_login()でユーザー名とパスワードを使って認証を行います。
3. ftp_nlist()に「.」（カレントディレクトリ）を渡すことで、そのディレクトリ内のファイル名一覧を配列として取得します。
4. var_dump()で取得した配列の内容を出力します。
5. 最後にftp_close()でFTP接続を明示的に閉じます。

注意点

パッシブモードが必要な環境では、ftp_pasv()を使用してパッシブモードを有効にしてからftp_nlist()を呼び出すことで、ファイアウォールやNAT環境下でも正しく動作させることができます。また、取得できるのはファイル名のみであり、詳細情報（サイズや更新日時など）が必要な場合はftp_rawlist()の利用を検討してください。