ftp_nb_put

Function • Params changed in PHP 8.1

Stores a file on the FTP server (non-blocking).

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
Improved
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

ftp_nb_put Function synopsis

ftp_nb_put(
    FTP\Connection $ftp,
    string $remote_filename,
    string $local_filename,
    int $mode = FTP_BINARY,
    int $offset = 0
  ): int|false

Parameters

$ftp

TypeFTP\Connection

$remote_filename

Typestring

The remote file path.

$local_filename

Typestring

The local file path.

$mode

OptionalTypeintDefault valueFTP_BINARY

The transfer mode. Must be either FTP_ASCII or FTP_BINARY.

$offset

OptionalTypeintDefault value0

The position in the remote file to start uploading to.

Return value

Typeint|false

Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA, or false on failure to open the local file.

Changes to the ftp_nb_put Function

PHP 8.1

  • Parameter type added for parameter #1 ($ftp): FTP\Connection
  ftp_nb_put(
-     $ftp,
+     FTP\Connection $ftp,
      string $remote_filename,
      string $local_filename,
      int $mode = FTP_BINARY,
      int $offset = 0
    ): int|false

PHP 8.0

  • Return type added: int|false
  • Parameter name of parameter #2 changed: $remote_file to $remote_filename
  • Parameter type added for parameter #2 ($remote_filename): string
  • Parameter name of parameter #3 changed: $local_file to $local_filename
  • Parameter type added for parameter #3 ($local_filename): string
  • Parameter type added for parameter #4 ($mode): int
  • Parameter default value added for position #4 ($mode): FTP_BINARY
  • Parameter name of parameter #5 changed: $startpos to $offset
  • Parameter type added for parameter #5 ($offset): int
  • Parameter default value added for position #5 ($offset): 0
  ftp_nb_put(
      $ftp,
-     $remote_file,
+     string $remote_filename,
-     $local_file,
+     string $local_filename,
-     $mode,
+     int $mode = FTP_BINARY,
-     $startpos
+     int $offset = 0
-   )
+   ): int|false

ftp_nb_put Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes