PHP ftp_get_option( ) Function

The ftp_get_option() function is used to retrieve various runtime behaviours of the current FTP stream. This function was introduced in PHP 4.2.0.

Syntax:

Parameter	Description	Is compulsory
ftp_stream	The link identifier of the FTP connection.	compulsory
Option	Specifies which runtime behaviour to return. Possible values: FTP_TIMEOUT_SEC - Returns the time limit for network operations FTP_AUTOSEEK - Returns TRUE if this option is on, FALSE otherwise	compulsory

Return value:

The ftp_get_option() function returns the value on success or FALSE if the given option is not supported. In the latter case, a warning message is also thrown.

Example 1

<?php
// Get the timeout of the given FTP stream
$timeout = ftp_get_option($conn_id, FTP_TIMEOUT_SEC);
?>

Explanation

In the above example, with the help of ftp_get_option() function we can get the various runtime behaviours of the current FTP stream.

Example 2

<?php
// connect and login to FTP server
$ftp_server = "ftp.example.com";
$ftp_conn = ftp_connect($ftp_server) or die("Could not connect to $ftp_server");
$login = ftp_login($ftp_conn, $ftp_username, $ftp_userpass);
// could return 90
echoftp_get_option($ftp_conn,FTP_TIMEOUT_SEC);
// close connection
ftp_close($ftp_conn);
?>