function drupal_unlink

Same name in other branches
  1. 8.9.x core/includes/file.inc \drupal_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

$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

unlink()

Related topics

18 calls to drupal_unlink()
Archive_Tar::_cleanFile in modules/system/system.tar.inc
Archive_Tar::_close in modules/system/system.tar.inc
Archive_Tar::_extractList in modules/system/system.tar.inc
Archive_Tar::_openAppend in modules/system/system.tar.inc
Archive_Tar::__destruct in modules/system/system.tar.inc

... See full list

File

includes/file.inc, line 2384

Code

function drupal_unlink($uri, $context = NULL) {
    $scheme = file_uri_scheme($uri);
    if ((!$scheme || !file_stream_wrapper_valid_scheme($scheme)) && substr(PHP_OS, 0, 3) == '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.