function backup_restore_prepare

Prepare for a single restore process, ensuring requirements are met.

Parameters

string $backup_file: The path to the backup file to be restored.

string $restore_target: The target to which the backup should be restored. Typically an indicator such as "db:default" (for the database) or "config:active" (for config).

array $backup_settings: An array of backup settings. This value is modified by reference.

array $errors: Any errors that were encountered while preparing for the backup. This value is modified by reference.

Return value

boolean: TRUE if the restore is ready to run, FALSE if errors were encountered.

File

core/includes/backup.inc, line 636

Contains functionality related to creating and restoring site backups.

Code

function backup_restore_prepare($backup_file, $restore_target, array &$backup_settings, array &$errors) {
  // No operation here for now, but available and called if needed.
  return TRUE;
}