function file_save_data

Saves a file to the specified destination and creates a database entry.

Parameters

string $data: A string containing the contents of the file.

string|null $destination: (optional) A string containing the destination URI. This must be a stream wrapper URI. If no value or NULL is provided, a randomized name will be generated and the file will be saved using Drupal's default files scheme, usually "public://".

int $replace: (optional) The replace behavior when the destination file already exists. Possible values include:

• FileSystemInterface::EXISTS_REPLACE: Replace the existing file. If a managed file with the destination name exists, then its database entry will be updated. If no database entry is found, then a new one will be created.
• FileSystemInterface::EXISTS_RENAME: (default) Append _{incrementing number} until the filename is unique.
• FileSystemInterface::EXISTS_ERROR: Do nothing and return FALSE.

Return value

\Drupal\file\FileInterface|false A file entity, or FALSE on error.

Throws

\Drupal\Core\Entity\EntityStorageException Thrown when there is an error updating the file storage.

See also

https://www.drupal.org/node/3223520

\Drupal\Core\File\FileSystemInterface::saveData()

File

core/modules/file/file.module, line 519

Defines a "managed_file" Form API field and a "file" field for Field module.

Code

function file_save_data($data, $destination = NULL, $replace = FileSystemInterface::EXISTS_RENAME) {
  @trigger_error(__FUNCTION__ . ' is deprecated in drupal:9.3.0 and will be removed in drupal:10.0.0. Use \\Drupal\\file\\FileRepositoryInterface::writeData() instead. See https://www.drupal.org/node/3223520', E_USER_DEPRECATED);
  if (empty($destination)) {
    $destination = \Drupal::config('system.file')
      ->get('default_scheme') . '://';
  }

  /** @var \Drupal\file\FileRepositoryInterface $fileRepository */
  $fileRepository = \Drupal::service('file.repository');
  try {
    return $fileRepository
      ->writeData($data, $destination, $replace);
  } catch (InvalidStreamWrapperException $e) {
    \Drupal::logger('file')
      ->notice('The data could not be saved because the destination %destination is invalid. This may be caused by improper use of file_save_data() or a missing stream wrapper.', [
      '%destination' => $destination,
    ]);
    \Drupal::messenger()
      ->addError(t('The data could not be saved because the destination is invalid. More information is available in the system log.'));
    return FALSE;
  } catch (FileException $e) {
    return FALSE;
  }
}