Open In App

PHP | ftp_get_option() function

Last Updated : 07 Aug, 2021
Comments
Improve
Suggest changes
Like Article
Like
Report

The ftp_get_option() function is an inbuilt function in PHP which is used to get runtime option for existing FTP Connection.

Syntax: 

ftp_get_option( $ftp_connection, $option )

Parameter: This function accepts two parameters as mentioned above and described below:  

  • $ftp_connection: It is required parameter. It specifies the already existing FTP connection.
  • $option: It is required parameter. It specifies the runtime option to return for existing FTP Connection. 
    Possible options are 
    • FTP_TIMEOUT_SEC: return time out used for the network.
    • FTP_AUTOSEEK: Returns if this option is on else returns FALSE.

Return Value: It returns the value of the option on success and False if the option is not supported.

Note:  

  • This function is available for PHP 4.2.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!";
        
        // Printing timeout for current ftp connection
        echo ftp_get_option($ftp_connection, FTP_TIMEOUT_SEC) . "<br>";
        
        // Printing whether FTP_AUTOSEEK enabled or not
        echo ftp_get_option($ftp_connection, FTP_AUTOSEEK) . "<br>";
         
    }
    else {
        echo "<br>login failed!";
    }
    
    // Closing  connection
    if(ftp_close($ftp_connection)) {
        echo "<br>Connection closed Successfully!";
    } 
}
?>

Output: 

successfully connected to the ftp server!
logged in successfully!
90
1
Connection closed Successfully!

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


Next Article

Similar Reads