PHP | renombrar( ) Función

La función de cambio de nombre() en PHP es una función incorporada que se utiliza para cambiar el nombre de un archivo o directorio. Intenta cambiar un nombre antiguo de un archivo o directorio con un nuevo nombre especificado por el usuario y puede moverse entre directorios si es necesario.
Si el nuevo nombre especificado por el usuario ya existe, la función rename() lo sobrescribe. El nombre antiguo del archivo y el nuevo nombre especificado por el usuario se envían como parámetros a la función rename() y devuelve True en caso de éxito y False en caso de error.

Sintaxis:

rename(oldname, newname, context)

Parámetros utilizados:
la función de cambio de nombre() en PHP acepta tres parámetros.

1. oldname: Es un parámetro obligatorio que especifica el nombre antiguo del archivo o directorio.
2. newname : Es un parámetro obligatorio que especifica el nuevo nombre del archivo o directorio.
3. contexto: Es un parámetro opcional que especifica el comportamiento del flujo.

Valor devuelto:
Devuelve True en caso de éxito y False en caso de fallo.

Errores y excepciones

1. La función rename() genera una advertencia si el nuevo nombre ya existe al cambiar el nombre de un directorio.
2. El contenedor utilizado en nombre antiguo debe coincidir con el contenedor utilizado en nombre nuevo.
3. Si el sistema de archivos de destino no permite que se realicen llamadas al sistema chown() o chmod() en los archivos, entonces la función rename() puede generar advertencias.

Ejemplos:

Input : $old_name = "gfg.txt" ; 
        $new_name = "newgfg.txt" ; 
        rename( $new_name, $old_name) ;

Output : 1

Input : $old_name = "gfg.txt" ;
        $new_name = "newgfg.txt" ; 
        if(file_exists($new_name))
        { 
           echo "Error While Renaming $old_name" ;
        }
        else
        {
           if(rename( $old_name, $new_name))
           { 
           echo "Successfully Renamed $old_name to $new_name" ;
           }
          else
          {
           echo "A File With The Same Name Already Exists" ;
          }
        }

Output : Successfully Renamed gfg.txt to newgfg.txt

Los siguientes programas ilustran la función renombrar().

Supongamos que hay un archivo llamado «gfg.txt»

Programa 1

<?php 
// Old Name Of The file
$old_name = "gfg.txt" ; 
  
// New Name For The File
$new_name = "newgfg.txt" ; 
  
// using rename() function to rename the file
rename( $old_name, $new_name) ;
  
?>

Producción:

1

Programa 2

<?php 
// Old Name Of The file
$old_name = "gfg.txt" ; 
   
// New Name For The File
$new_name = "newgfg.txt" ; 
   
// Checking If File Already Exists
if(file_exists($new_name))
 { 
   echo "Error While Renaming $old_name" ;
 }
else
 {
   if(rename( $old_name, $new_name))
     { 
        echo "Successfully Renamed $old_name to $new_name" ;
     }
     else
     {
        echo "A File With The Same Name Already Exists" ;
     }
  }
?>

Producción:

Successfully Renamed gfg.txt to newgfg.txt

Artículos relacionados:

• PHP | función copiar()
• PHP | función desvincular()

Referencia:
http://php.net/manual/en/function.rename.php