php8.5
Home/ Manual/ ftp / functions/ ftp_get_option

ftp_get_option

PHP function Edit on GitHub ✎

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

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

Ftp

option

Currently, the following options are supported:

FTP_TIMEOUT_SECReturns the current timeout used for network related operations.
FTP_AUTOSEEKReturns 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

VersionDescription

Examples

ftp_get_option() example

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

See Also

Source: reference/ftp/functions/ftp-get-option.xml · from the official PHP manual (php/doc-en)