drupal_chmod

  1. drupal
    1. 8
    2. 7
Versions
8 – 7 drupal_chmod($uri, $mode = NULL)

Set the permissions on a file or directory.

This function will use the 'file_chmod_directory' and 'file_chmod_file' variables for the default modes for directories and uploaded/generated files. By default these will give everyone read access so that users accessing the files with a user account without the webserver group (e.g. via FTP) can read these files, and give group write permissions so webserver group members (e.g. a vhost account) can alter files uploaded and owned by the webserver.

PHP's chmod does not support stream wrappers so we use our wrapper implementation which interfaces with chmod() by default. Contrib wrappers may override this behavior in their implementations as needed.

Parameters

$uri A string containing a URI file, or directory path.

$mode Integer value for the permissions. Consult PHP chmod() documentation for more information.

Return value

TRUE for success, FALSE in the event of an error.

Related topics

▾ 9 functions call drupal_chmod()

FileDirectoryTest::testFileCheckDirectoryHandling in modules/simpletest/tests/file.test
Test directory handling functions.
file_create_htaccess in includes/file.inc
Creates an .htaccess file in the given directory.
file_prepare_directory in includes/file.inc
Check that the directory exists and is writable.
file_save_upload in includes/file.inc
Saves a file upload to a new location.
file_unmanaged_copy in includes/file.inc
Copies a file to a new location without invoking the file API.
image_save in includes/image.inc
Close the image and save the changes to a file.
system_check_directory in modules/system/system.module
Checks the existence of the directory specified in $form_element.
_color_render_images in modules/color/color.module
Render images that match a given palette.
_color_save_stylesheet in modules/color/color.module
Save the rewritten stylesheet to disk.

Code

includes/file.inc, line 2136

<?php
function drupal_chmod($uri, $mode = NULL) {
  if (!isset($mode)) {
    if (is_dir($uri)) {
      $mode = variable_get('file_chmod_directory', 0775);
    }
    else {
      $mode = variable_get('file_chmod_file', 0664);
    }
  }

  // If this URI is a stream, pass it off to the appropriate stream wrapper.
  // Otherwise, attempt PHP's chmod. This allows use of drupal_chmod even
  // for unmanaged files outside of the stream wrapper interface.
  if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) {
    if ($wrapper->chmod($mode)) {
      return TRUE;
    }
  }
  else {
    if (@chmod($uri, $mode)) {
      return TRUE;
    }
  }

  watchdog('file', 'The file permissions could not be set on %uri.', array('%uri' => $uri), WATCHDOG_ERROR);
  return FALSE;
}
?>