ftp_set_option

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

ftp_set_option — Set miscellaneous runtime FTP options

Description

ftp_set_option(FTP\Connection $ftp, int $option, int|bool $value): true

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

Parameters

ftp

An FTP\Connection instance.

option

Currently, the following options are supported:

Supported runtime FTP options
FTP_TIMEOUT_SECChanges 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_AUTOSEEKWhen 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_USEPASVADDRESSWhen 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

Always returns true.

Errors/Exceptions

A ValueError is thrown if the option is not supported. A TypeError is thrown if the passed value doesn't match the expected type for the given option.

Changelog

VersionDescription
8.5.0The return type is true now; previously, it was bool.
8.1.0The ftp parameter expects an FTP\Connection instance now; previously, a resource was expected.

Examples

Example #1 ftp_set_option() example

<?php
// Set the network timeout to 10 seconds
ftp_set_option($ftp, FTP_TIMEOUT_SEC, 10);
?>

See Also

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