Open In App

PHP | ftp_rawlist() function

Last Updated : 28 Nov, 2022
Comments
Improve
Suggest changes
Like Article
Like
Report

The ftp_rawlist() function is an inbuilt function in PHP which returns a list of files with information like permissions, last modified the files from a specified directory on Remote server i.e. FTP Server.
 

Syntax:  

ftp_rawlist( $ftp_connection, $directory, $recursive )


Parameters: This function accepts three parameters as mentioned above and described below:  

  • $ftp_connection: It is required parameter. It specifies the already existing FTP connection.
  • $directory: It is required parameter. It specifies the path of the directory in remote server i.e. FTP server whose files information to be retrieved. './' is used for current directory, '../' is used for parent directory of the current directory. It may include argument for LIST command.
  • $recursive: It is optional parameter. It specifies whether LIST or LIST -R command to send to server. If sets TRUE then it sends LIST -R command. By default it sends LIST command.


Return Value:  

  • On Success: It returns an array whose each element corresponds to one line of text.
  • On failure: It returns FALSE. In case like when invalid directory is passed.


Note:  

  • This function is available for PHP 4.0.0 and newer version.
  • The following examples cannot be run on online IDE. So try to run in some PHP hosting server or localhost with proper ftp server name.


Example: 

php
<?php

// Connect to FTP server

// Use a correct ftp server
$ftp_server = "localhost";

// Use correct ftp username
$ftp_username = "username";

// Use correct ftp password corresponding
// to the ftp username
$ftp_userpass = "password";
 
// Establishing ftp connection 
$ftp_connection = ftp_connect($ftp_server) 
        or die("Could not connect to $ftp_server");

if($ftp_connection) {
    echo "successfully connected to the ftp server!";
    
    // Logging in to established connection with
    // ftp username password
    $login = ftp_login($ftp_connection,
            $ftp_username, $ftp_userpass);
    
    if($login) {
        
        // Checking whether logged in successfully
        // or not
        echo "<br>logged in successfully!";
        
        // Storing  data in $file_list
        $file_list = ftp_rawlist($ftp_connection, "/");
        
        // Printing raw array with print_r()
        print_r($file_list);
    }
    else {
        echo "<br>login failed!";
    }
    
    // Closing  connection
    if(ftp_close($ftp_connection)) {
        echo "<br>Connection closed Successfully!";
    } 
}
?>

Output: 


Reference: https://www.php.net/manual/en/function.ftp-rawlist.php


Next Article

Similar Reads