function drush_delete_dir

Deletes the provided file or folder and everything inside it.

Usually respects read-only files and folders. To do a forced delete use drush_delete_tmp_dir() or set the parameter $forced.

Parameters

$dir: The file or directory to delete.

$force: Try whatever possible to delete the directory - also read-only ones.

$follow_symlinks: Do not delete symlinked files. Simply unlink symbolic links.

Return value

FALSE on failure, TRUE if everything was deleted.

Related topics

File

includes/filesystem.inc, line 118

Code

function drush_delete_dir($dir, $force = FALSE, $follow_symlinks = FALSE) {
  // Do not delete symlinked files, only unlink symbolic links
  if (is_link($dir) && !$follow_symlinks) {
    return unlink($dir);
  }
  // Allow to delete symlinks even if the target doesn't exist.
  if (!is_link($dir) && !file_exists($dir)) {
    return TRUE;
  }
  if (!is_dir($dir)) {
    if ($force) {
      // Force deletion of items with readonly flag.
      @chmod($dir, 0777);
    }
    return unlink($dir);
  }
  foreach (scandir($dir) as $item) {
    if ($item == '.' || $item == '..') {
      continue;
    }
    if ($force) {
      @chmod($dir, 0777);
    }
    if (!drush_delete_dir($dir . '/' . $item, $force)) {
      return FALSE;
    }
  }
  if ($force) {
    // Force deletion of items with readonly flag.
    @chmod($dir, 0777);
  }
  return rmdir($dir);
}