Home/ Manual/ ftp / functions/ ftp_rawlist

ftp_rawlist

PHP function Edit on GitHub ✎

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

Returns a detailed list of files in the given directory

Description

ftp_rawlist(FTP\Connection $ftp, string $directory, bool $recursive = false): array|false

ftp_rawlist() executes the FTP LIST command, and returns the result as an array.

Parameters

ftp: Ftp
directory: The directory path. May include arguments for the LIST command.
recursive: If set to true, the issued command will be LIST -R.

Return Values

Returns an array where each element corresponds to one line of text. Returns false when passed directory is invalid.

The output is not parsed in any way. The system type identifier returned by ftp_systype() can be used to determine how the results should be interpreted.

Changelog

Version	Description

Examples

ftp_rawlist() example

php

<?php

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

// get the file list for /
$buff = ftp_rawlist($ftp, '/');

// close the connection
ftp_close($ftp);

// output the buffer
var_dump($buff);
?>

The above example will output something similar to:

output

array(3) {
  [0]=>
  string(65) "drwxr-x---   3 vincent  vincent      4096 Jul 12 12:16 public_ftp"
  [1]=>
  string(66) "drwxr-x---  15 vincent  vincent      4096 Nov  3 21:31 public_html"
  [2]=>
  string(73) "lrwxrwxrwx   1 vincent  vincent        11 Jul 12 12:16 www -> public_html"
}