function FileSystemInterface::rmdir

Same name in other branches
  1. 9 core/lib/Drupal/Core/File/FileSystemInterface.php \Drupal\Core\File\FileSystemInterface::rmdir()
  2. 8.9.x core/lib/Drupal/Core/File/FileSystemInterface.php \Drupal\Core\File\FileSystemInterface::rmdir()
  3. 10 core/lib/Drupal/Core/File/FileSystemInterface.php \Drupal\Core\File\FileSystemInterface::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

string $uri: A URI or pathname.

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

Return value

bool Boolean TRUE on success, or FALSE on failure.

See also

rmdir()

Related topics

1 method overrides FileSystemInterface::rmdir()
FileSystem::rmdir in core/lib/Drupal/Core/File/FileSystem.php
Removes a directory.

File

core/lib/Drupal/Core/File/FileSystemInterface.php, line 238

Class

FileSystemInterface
Provides an interface for helpers that operate on files and stream wrappers.

Namespace

Drupal\Core\File

Code

public function rmdir($uri, $context = NULL);

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