file_ensure_htaccess

file_ensure_htaccess()

Creates a .htaccess file in each Drupal files directory if it is missing.

File

core/includes/file.inc, line 313: API for handling file uploads and server file management.

Code

function file_ensure_htaccess() {
  file_save_htaccess('public://', FALSE);
  $private_path = PrivateStream::basePath();
  if (!empty($private_path)) {
    file_save_htaccess('private://', TRUE);
  }
  file_save_htaccess('temporary://', TRUE);
 
  // If a staging directory exists then it should contain a .htaccess file.
  // @todo https://www.drupal.org/node/2696103 catch a more specific exception
  //   and simplify this code.
  try {
    $staging = config_get_config_directory(CONFIG_SYNC_DIRECTORY);
  }
  catch (\Exception $e) {
    $staging = FALSE;
  }
  if ($staging) {
    // Note that we log an error here if we can't write the .htaccess file. This
    // can occur if the staging directory is read-only. If it is then it is the
    // user's responsibility to create the .htaccess file.
    file_save_htaccess($staging, TRUE);
  }
}

Links:

https://api.drupal.org/api/drupal/core%21includes%21file.inc/function/file_ensure_htaccess/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments

file_ensure_htaccess

Related topics

File

Code