How to Recursively Delete a Directory and its Entire Contents (files + sub dirs) in PHP


PHP: PHP (Hypertext Preprocessor) is a widely-used open-source server-side scripting language that is specifically designed for web development. It was originally created by Rasmus Lerdorf in 1994 and has since evolved into a powerful language used by millions of developers worldwide.

PHP is primarily used to develop dynamic web pages and web applications. It allows developers to embed PHP code within HTML, making it easy to mix server-side logic with the presentation layer. PHP scripts are executed on the server, and the resulting HTML is sent to the client's browser.

There are multiple ways to recursively delete a directory and its entire contents (files and subdirectories) in PHP. Here are three common methods:

  • Using the rmdir() and unlink() functions recursively

  • Using the glob() function

  • Using the RecursiveDirectoryIterator and RecursiveIteratorIterator classes

Using the rmdir() and unlink() functions recursively

To recursively delete a directory and its entire contents (files and subdirectories) in PHP using the rmdir() and unlink() functions,

Example

<?php
function deleteDirectory($dirPath) {
   if (is_dir($dirPath)) {
      $files = scandir($dirPath);
      foreach ($files as $file) {
         if ($file !== '.' && $file !== '..') {
            $filePath = $dirPath . '/' . $file;
            if (is_dir($filePath)) {
               deleteDirectory($filePath);
            } else {
               unlink($filePath);
            }
         }
      }
      rmdir($dirPath);
   }
}
?>

Here's an Explanation of the Code

The deleteDirectory() function is defined, which takes the directory path as a parameter.

It checks if the given path is a directory using is_dir($dirPath). If it's not a directory, the function returns.

If it's a directory, it uses scandir($dirPath) to retrieve a list of files and directories within the specified directory.

It iterates through each file and directory, excluding the special entries "." and "..".

For each entry, it constructs the full file path by concatenating the directory path and the file name.

If the entry is a subdirectory, the deleteDirectory() function is recursively called on that subdirectory.

If the entry is a file, unlink($filePath) is used to delete the file.

After processing all files and subdirectories, rmdir($dirPath) is called to remove the empty directory itself.

To use this function, simply call it with the path of the directory you want to delete:

<?php
   $directoryPath = '/path/to/directory';
   deleteDirectory($directoryPath);
?>

Make sure you have proper permissions to delete the files and directories within the specified path.

Using the glob() function

To recursively delete a directory and its entire contents (files and subdirectories) in PHP using the glob() function,

Example

<?php
function deleteDirectory($dirPath) {
   $files = glob($dirPath . '/*');
   foreach ($files as $file) {
      if (is_dir($file)) {
         deleteDirectory($file);
      } else {
         unlink($file);
      }
   }
   rmdir($dirPath);
}
?>

Here's an Explanation of the Code

The deleteDirectory() function is defined, which takes the directory path as a parameter.

It uses the glob() function with the pattern $dirPath . '/*' to retrieve a list of files and directories within the specified directory.

It iterates through each entry obtained from glob().

For each entry, it checks if it's a directory using is_dir($file).

If it's a directory, the deleteDirectory() function is recursively called on that subdirectory to delete its contents.

If it's a file, unlink($file) is used to delete the file.

After processing all files and subdirectories, rmdir($dirPath) is called to remove the empty directory itself.

To use this function, simply call it with the path of the directory you want to delete:

<?php
$directoryPath = '/path/to/directory';
deleteDirectory($directoryPath);
?>

Make sure you have proper permissions to delete the files and directories within the specified path.

Using the RecursiveDirectoryIterator and RecursiveIteratorIterator classes

To recursively delete a directory and its entire contents (files and subdirectories) in PHP using the RecursiveDirectoryIterator and RecursiveIteratorIterator classes,

Example

<?php
function deleteDirectory($dirPath) {
   $iterator = new RecursiveIteratorIterator(
      new RecursiveDirectoryIterator($dirPath, 
RecursiveDirectoryIterator::SKIP_DOTS),
      RecursiveIteratorIterator::CHILD_FIRST
   );
   foreach ($iterator as $file) {
      if ($file->isDir()) {
         rmdir($file->getPathname());
      } else {
         unlink($file->getPathname());
      }
   }
     rmdir($dirPath);
}

?>

Here's an Explanation of the Code

The deleteDirectory() function is defined, which takes the directory path as a parameter.

It creates a RecursiveDirectoryIterator object using the specified directory path. The RecursiveDirectoryIterator::SKIP_DOTS flag is used to exclude the special entries "." and ".." from the iteration.

It creates a RecursiveIteratorIterator object to iterate through the files and directories in a recursive manner. The RecursiveIteratorIterator::CHILD_FIRST flag is used to ensure that the child elements are processed before the parent elements.

It iterates through each file and directory using a foreach loop on the $iterator.

For each entry, it checks if it's a directory using $file->isDir().

If it's a directory, rmdir($file->getPathname()) is used to remove the directory.

If it's a file, unlink($file->getPathname()) is used to delete the file.

After processing all files and subdirectories, rmdir($dirPath) is called to remove the empty directory itself.

To use this function, simply call it with the path of the directory you want to delete:

<?php
   $directoryPath = '/path/to/directory';
   deleteDirectory($directoryPath);
?>

Make sure you have proper permissions to delete the files and directories within the specified path.

Conclusion

These methods provide different approaches to achieve the same result. You can choose the method that suits your specific requirements and coding preferences. Remember to handle permissions properly to ensure that you have the necessary privileges to delete files and directories.

Updated on: 01-Aug-2023

858 Views

Kickstart Your Career

Get certified by completing the course

Get Started
Advertisements