Php/docs/function.ftp-set-option

• PHP Manual
• FTP Functions
• Set miscellaneous runtime FTP options

ftp_set_option

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

ftp_set_option — Set miscellaneous runtime FTP options

Description

ftp_set_option ( resource $ftp_stream , int $option , mixed $value ) : bool

This function controls various runtime options for the specified FTP stream.

Parameters

ftp_stream

The link identifier of the FTP connection.

option

Currently, the following options are supported:

Supported runtime FTP options

FTP_TIMEOUT_SEC	Changes the timeout in seconds used for all network related functions. value must be an integer that is greater than 0. The default timeout is 90 seconds.
FTP_AUTOSEEK	When enabled, GET or PUT requests with a resumepos or startpos parameter will first seek to the requested position within the file. This is enabled by default.
FTP_USEPASVADDRESS	When disabled, PHP will ignore the IP address returned by the FTP server in response to the PASV command and instead use the IP address that was supplied in the ftp_connect(). value must be a boolean.

value

This parameter depends on which option is chosen to be altered.

Return Values

Returns TRUE if the option could be set; FALSE if not. A warning message will be thrown if the option is not supported or the passed value doesn't match the expected value for the given option.

Examples

Example #1 ftp_set_option() example

<?php// Set the network timeout to 10 secondsftp_set_option($conn_id, FTP_TIMEOUT_SEC, 10);?>

See Also

• ftp_get_option() - Retrieves various runtime behaviours of the current FTP stream