Home/ Manual/ ftp / functions/ ftp_set_option

ftp_set_option

PHP function Edit on GitHub ✎

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

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

Ftp

option

Currently, the following options are supported:

`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

Always

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

Version	Description
8.5.0	The return type is true now; previously, it was `bool`.

Examples

ftp_set_option() example

php

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