Lists a remote directory as standardized MLSD facts when supported. This guide demonstrates its use in PHP code and explains when the result or side effect needs extra checks.
What It Does
Lists a remote directory as standardized MLSD facts when supported.
Syntax and Parameters
The examples below show a real call to ftp_mlsd with suitable arguments. Read the function call in context: its connection, handle, input data or other prerequisites are created before use.
Requirements: FTP extension and a controlled test FTP/FTPS server; ftp_ssl_connect does not validate the server certificate.
Compatibility and security: Important: ftp_ssl_connect does not verify the server certificate; it is unsuitable alone for authenticating a remote FTPS server. Prefer a transport implementation with peer verification (or an approved SFTP client) for untrusted networks. FTP and SFTP are different protocols.
These examples are for an isolated development environment. Hostnames, credentials and remote paths must be replaced with your approved configuration.
Example 1: Core Behavior
Configure a test FTPS server and a dedicated low-privilege account before running this example.
<?php
$host = getenv('FTP_HOST'); $user = getenv('FTP_USER'); $pass = getenv('FTP_PASSWORD');
if (!$host || !$user || !$pass) { throw new RuntimeException('Configure FTP_HOST, FTP_USER and FTP_PASSWORD'); }
// ftp_ssl_connect does not verify the peer certificate; use only on a trusted test server.
$ftp = ftp_ssl_connect($host, 21, 8);
if (!$ftp || !ftp_login($ftp, $user, $pass)) { throw new RuntimeException('FTPS connection/login failed'); }
ftp_pasv($ftp, true);
$rows = ftp_mlsd($ftp, '/exports');
if ($rows === false) throw new RuntimeException("FTP listing/command failed");
foreach (array_slice($rows, 0, 2) as $entry) { echo json_encode($entry) . PHP_EOL; }
ftp_close($ftp);Observe the returned value or changed resource state. A successful function call can still require additional checks before a higher-level operation is considered successful.
Example 2: Alternative or Failure Case
Repeat with an account limited to the correct directory and check the returned status.
<?php
$host = getenv('FTP_HOST'); $user = getenv('FTP_USER'); $pass = getenv('FTP_PASSWORD');
if (!$host || !$user || !$pass) { throw new RuntimeException('Configure FTP_HOST, FTP_USER and FTP_PASSWORD'); }
// ftp_ssl_connect does not verify the peer certificate; use only on a trusted test server.
$ftp = ftp_ssl_connect($host, 21, 9);
if (!$ftp || !ftp_login($ftp, $user, $pass)) { throw new RuntimeException('FTPS connection/login failed'); }
ftp_pasv($ftp, true);
$rows = ftp_mlsd($ftp, '/exports');
if ($rows === false) throw new RuntimeException("FTP listing/command failed");
foreach (array_slice($rows, 0, 3) as $entry) { echo json_encode($entry) . PHP_EOL; }
ftp_close($ftp);Compare the different inputs, environment assumptions or result checks. Do not use a transport-level success value as proof that all business-level requirements were met.
Practical Example: Applying the Rule
A production workflow must also validate remote paths and handle errors without exposing credentials.
<?php
$host = getenv('FTP_HOST'); $user = getenv('FTP_USER'); $pass = getenv('FTP_PASSWORD');
if (!$host || !$user || !$pass) { throw new RuntimeException('Configure FTP_HOST, FTP_USER and FTP_PASSWORD'); }
// ftp_ssl_connect does not verify the peer certificate; use only on a trusted test server.
$ftp = ftp_ssl_connect($host, 21, 10);
if (!$ftp || !ftp_login($ftp, $user, $pass)) { throw new RuntimeException('FTPS connection/login failed'); }
ftp_pasv($ftp, true);
$rows = ftp_mlsd($ftp, '/exports');
if ($rows === false) throw new RuntimeException("FTP listing/command failed");
foreach (array_slice($rows, 0, 4) as $entry) { echo json_encode($entry) . PHP_EOL; }
ftp_close($ftp);In an application, convert low-level failures into controlled responses and log only non-sensitive diagnostic context.
Important Behavior and Edge Cases
Returns false if unsupported or unavailable; compare fact names defensively.
Check both authentication and operation results; FTP server capabilities and directory permissions vary. PHP ftp_ssl_connect does not verify TLS peer certificates, so the examples are limited to trusted test environments and are not a secure Internet-facing FTPS implementation.
Comparison with Related Functions or Patterns
| Approach | When it differs |
|---|---|
| ftp_mlsd | Lists a remote directory as standardized MLSD facts when supported. |
| Related API or pattern | ftp_nlist gives simpler filenames, and ftp_rawlist returns server-formatted listing lines. |
Common Beginner Mistakes
| Mistake | Correct approach |
|---|---|
| Assuming every FTP server supports this operation and that FTPS verifies certificates | Returns false if unsupported or unavailable; compare fact names defensively. |
| Substituting a related API without checking its semantics | ftp_nlist gives simpler filenames, and ftp_rawlist returns server-formatted listing lines. |
Key Takeaways
- Lists a remote directory as standardized MLSD facts when supported.
- Returns false if unsupported or unavailable; compare fact names defensively.
- ftp_nlist gives simpler filenames, and ftp_rawlist returns server-formatted listing lines.
Select this API or pattern based on its documented behavior and the trust boundaries in your own application, and test all external integrations against their actual deployments.