ftp_rename

(PHP 4, PHP 5, PHP 7, PHP 8)

ftp_rename — Benennt eine Datei auf dem FTP-Server um

Beschreibung

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

ftp_rename() benennt eine Datei oder ein Verzeichnis auf dem FTP_Server um.

Parameter-Liste

ftp: Eine FTP\Connection-Instanz.
from: Der alte Datei-/Verzeichnisname.
to: Der neue Name.

Rückgabewerte

Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben. Im Fehlerfall (wie dem Versuch, eine nicht exisitierende Datei umzubenennen) wird ein E_WARNING-Fehler erzeugt.

Changelog

Version	Beschreibung
8.1.0	Der Parameter `ftp` erwartet nun eine FTP\Connection-Instanz; vorher wurde eine Ressource erwartet.

Beispiele

Beispiel #1 ftp_rename()-Beispiel

<?php
$old_file = 'somefile.txt.bak';
$new_file = 'somefile.txt';

// Verbindung aufbauen
$ftp = ftp_connect($ftp_server);

// Login mit Benutzername und Passwort
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);

// Versuche $old_file in $new_file umzubenennen
if (ftp_rename($ftp, $old_file, $new_file)) {
    echo "$old_file erfolgreich in $new_file umbenannt\n";
} else {
    echo "Ein Fehler trat beim Umbenennen von $old_file in $new_file auf\n";
}

// Verbindung schließen
ftp_close($ftp);
?>

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 4 notes

down

Hugo locobyte at hotmail dot NO_SPAM dot com ¶

22 years ago

Using "ftp_rename" to move files to other directories on server ftp
..
...
if(ftp_rename($conn_ftp, $xfiles[$i], "./dirx/".$xfiles[$i])) {
       echo "File $xfiles[$i] moved to ./dirx";
} else {
       echo "ERROR!!!. The file could not be moved";
}
...
..
#-->>h2m,  bye

down

alishahnovin at hotmail dot com ¶

17 years ago

You want to make sure you check the existence of the new name before renaming files, because otherwise you could risk losing files. Just do a simple check with ftp_size with the new name. If it's !=-1, you're going to want to throw some kind of error, otherwise you'll be losing a file...

down

Hazem dot Khaled at gmail dot com ¶

18 years ago

to rename the file or folder you should use ftp_chdir to select the current directory on ftp server or you should write the full path to file in old name and in new name

Ex. 1
<?php
// open the folder that have the file
ftp_chdir($conn_id, '/www/ftp-filemanager/');

// rename the file
ftp_rename($conn_id, 'file1.jpg', 'new_name_4_file.jpg');
?>

or write full path Ex. 2
<?
// rename the file
ftp_rename($conn_id, '/www/ftp-filemanager/file1.jpg', '/www/ftp-filemanager/new_name_4_file.jpg');
?>

down

-1

aventaria at hotmxxx dot com ¶

17 years ago

This function isn't only able to rename files, but also folders. And it is not only able to rename them, but also move them, and, in the case of folders, their contents as well (so folders don't have to be empty to move). For example:

<?php
ftp_rename($conn_id, "./dir1/dir2/", "./dir3/");
?>

Now the folder dir2 (which prevously was in folder dir1) has moved to the same folder as dir1, and it has kept its original contents (the content just moved along).

＋add a note