Error message

You are browsing documentation for drupal 7.x, which is not supported anymore. Read the updated version of this page for drupal 11.x (the latest version).

function drupal_rmdir

Same name and namespace in other branches
  1. 8.9.x core/includes/file.inc \drupal_rmdir()

Removes a directory.

PHP's rmdir() is broken on Windows, as it can fail to remove a directory when it has a read-only flag set.

Parameters

$uri: A URI or pathname.

$context: Refer to http://php.net/manual/ref.stream.php

Return value

Boolean TRUE on success, or FALSE on failure.

See also

rmdir()

Related topics

PHP wrapper functions
Functions that are wrappers or custom implementations of PHP functions.
File interface
Common file handling functions.
6 calls to drupal_rmdir()
color_scheme_form_submit in modules/color/color.module
Form submission handler for color_scheme_form().
DrupalLocalStreamWrapper::rmdir in includes/stream_wrappers.inc
Support for rmdir().
FileTransferLocal::removeDirectoryJailed in includes/filetransfer/local.inc
Removes a directory.
file_unmanaged_delete_recursive in includes/file.inc
Deletes all files and directories in the specified filepath recursively.
locale_uninstall in modules/locale/locale.install
Implements hook_uninstall().

... See full list

File

includes/file.inc, line 2616

Code

function drupal_rmdir ($uri, $context = NULL) {
 $scheme = file_uri_scheme ($uri);
 if ((!$scheme || !file_stream_wrapper_valid_scheme ($scheme)) && substr (PHP_OS, 0, 3) == 'WIN') {
 chmod ($uri, 0700);
 }
 if ($context) {
 return rmdir ($uri, $context);
 }
 else {
 return rmdir ($uri);
 }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.