array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.ftp-get-option.php', 1 => 'ftp_get_option', 2 => 'Retrieves various runtime behaviours of the current FTP connection', ), 'up' => array ( 0 => 'ref.ftp.php', 1 => 'FTP Functions', ), 'prev' => array ( 0 => 'function.ftp-get.php', 1 => 'ftp_get', ), 'next' => array ( 0 => 'function.ftp-login.php', 1 => 'ftp_login', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/ftp/functions/ftp-get-option.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

ftp_get_option

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

ftp_get_option — Retrieves various runtime behaviours of the current FTP connection

Description

ftp_get_option(FTP\Connection $ftp, int $option): int|bool

This function returns the value for the requested option from the specified FTP connection.

Parameters

ftp

An FTP\Connection instance.

option

Currently, the following options are supported:
Supported runtime FTP options
FTP_TIMEOUT_SEC Returns the current timeout used for network related operations.
FTP_AUTOSEEK Returns true if this option is on, false otherwise.

Return Values

Returns the value on success or false if the given option is not supported. In the latter case, a warning message is also thrown.

Changelog

Version Description
8.1.0 The ftp parameter expects an FTP\Connection instance now; previously, a resource was expected.

Examples

Example #1 ftp_get_option() example

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

See Also