function FileSystem::unlink

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/File/FileSystem.php \Drupal\Core\File\FileSystem::unlink()
  2. 8.9.x core/lib/Drupal/Core/File/FileSystem.php \Drupal\Core\File\FileSystem::unlink()
  3. 11.x core/lib/Drupal/Core/File/FileSystem.php \Drupal\Core\File\FileSystem::unlink()

Deletes a file.

PHP's unlink() is broken on Windows, as it can fail to remove a file 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.

Overrides FileSystemInterface::unlink

1 call to FileSystem::unlink()
FileSystem::delete in core/lib/Drupal/Core/File/FileSystem.php
Deletes a file without database changes or hook invocations.

File

core/lib/Drupal/Core/File/FileSystem.php, line 110

Class

FileSystem
Provides helpers to operate on files and stream wrappers.

Namespace

Drupal\Core\File

Code

public function unlink($uri, $context = NULL) {
  if (!$this->streamWrapperManager
    ->isValidUri($uri) && str_starts_with(PHP_OS, 'WIN')) {
    chmod($uri, 0600);
  }
  if ($context) {
    return unlink($uri, $context);
  }
  else {
    return unlink($uri);
  }
}

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