ftp_rename

Function • Params changed in PHP 8.1

Renames a file or a directory on the FTP server.

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_rename Function synopsis

ftp_rename(
    FTP\Connection $ftp,
    string $from,
    string $to
  ): bool

Parameters

$ftp

TypeFTP\Connection

$from

Typestring

The old file/directory name.

$to

Typestring

The new name.

Return value

Typebool

Returns true on success, false on failure Upon failure (such as attempting to rename a non-existent file), an E_WARNING error will be emitted.

Changes to the ftp_rename Function

PHP 8.1

  • Parameter type added for parameter #1 ($ftp): FTP\Connection
  ftp_rename(
-     $ftp,
+     FTP\Connection $ftp,
      string $from,
      string $to
    ): bool

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #2 changed: $src to $from
  • Parameter type added for parameter #2 ($from): string
  • Parameter name of parameter #3 changed: $dest to $to
  • Parameter type added for parameter #3 ($to): string
  ftp_rename(
      $ftp,
-     $src,
+     string $from,
-     $dest
+     string $to
-   )
+   ): bool

ftp_rename 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