Creates a .htaccess file in the given directory.

@internal

Parameters

string $directory: The directory.

bool $deny_public_access: (Optional) FALSE indicates that $directory should be a web-accessible directory. Defaults to TRUE which indicates a private directory.

bool $force_overwrite: (Optional) Set to TRUE to attempt to overwrite the existing .htaccess file if one is already present. Defaults to FALSE.

Return value

bool TRUE if the .htaccess file was saved, already exists or auto-creation is disabled, FALSE otherwise.

See also

\Drupal\Component\FileSecurity\FileSecurity::writeHtaccess()

1 call to HtaccessWriter::write()

HtaccessWriter::ensure in core/lib/Drupal/Core/File/HtaccessWriter.php

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

File

core/lib/Drupal/Core/File/HtaccessWriter.php, line 83

Class

HtaccessWriter

Provides functions to manage Apache .htaccess files.

Namespace

Drupal\Core\File

Code

public function write($directory, $deny_public_access = TRUE, $force_overwrite = FALSE) {
  if (!$this->settings
    ->get('auto_create_htaccess', TRUE)) {
    return TRUE;
  }
  if (StreamWrapperManager::getScheme($directory)) {
    $directory = $this->streamWrapperManager
      ->normalizeUri($directory);
  }
  else {
    $directory = rtrim($directory, '/\\');
  }
  if (FileSecurity::writeHtaccess($directory, $deny_public_access, $force_overwrite)) {
    return TRUE;
  }
  $this->logger
    ->error("Security warning: Couldn't write .htaccess file. Create a .htaccess file in your %directory directory which contains the following lines: <pre><code>@htaccess</code></pre>", [
    '%directory' => $directory,
    '@htaccess' => FileSecurity::htaccessLines($deny_public_access),
  ]);
  return FALSE;
}

---