Before a restore writes anything, the plugin checks nine points. This article explains what each point checks, what its finding means and what you can do if a point shows a warning or blocks the start.
The pre-check is in the tile Prepare restore on the Restore page. You open the tile with Restore latest backup or with Restore in the menu of a backup.
When the pre-check runs
- Automatically on opening: the pre-check starts as soon as the tile Prepare restore opens.
- After every change: if you change the scope, a switch or the view, the pre-check runs again shortly afterwards. The result of the most recent pre-check is the one that counts.
- By hand: Run pre-check repeats the pre-check.
- In the restore itself: the first step of every restore is the same pre-check. If a point blocks the start there, the restore ends before anything is written.
The pre-check writes nothing to the website. For two points the plugin creates folders, a file and tables as a test and removes them again immediately.
- The note is shown in place of the switches until the first pre-check has answered: the pre-check determines the defaults of the switches. Only the Extended view shows this note.
- Run pre-check shows a waiting symbol while the pre-check is running.
- As long as there is no result yet, every point shows a spinning ring and checking …
- Start restore is blocked until the pre-check has passed.
Reading the result
- The line shows the duration of the pre-check and the target from which the backup is read. The target is shown with its ID, for example “local-1”.
- Every point of the pre-check has a coloured dot, its name, the state and the finding.
- Not restored: lists what the restore leaves out, and why.
- Start restore is enabled: no point blocks the start.
Every point ends with one of four states. The state is followed by the finding in words.
| State | Meaning | Start possible |
|---|---|---|
|
green OK |
The point is in order. | yes |
|
yellow Warning |
Something you should know. You assess the risk and decide. | yes |
|
red Blocked |
The restore cannot start like this. | no |
|
grey Not checked |
The point could not be determined. | yes |
Differences are shown, not judged
The plugin shows you every difference and every risk between the backup and this website. It cannot know whether a plugin from the backup runs under another PHP version. If you start the restore anyway, it takes the best possible route, at your own risk. Only what is impossible is blocked: a backup that cannot be read, missing write permissions or database rights, a row that the database server does not accept, too little space.
The nine points
1. Backup readable and complete
The plugin reads the backup at a target where it is stored completely. A local folder takes precedence. It checks these things: every file of the backup is at the target, the info file is valid, and every part has the size given in the info file. In addition, the info file at the target must be the one this website remembered for this backup. That is the short check. To read every block of the backup, use Check backup on the Backup page: Check a backup.
| Finding | Meaning | What you can do |
|---|---|---|
|
OK read in place at a local target |
The backup is in a local folder. The restore reads it there. | Nothing. |
|
OK read through the work folder |
The backup is at an external target. The restore fetches it part by part into the work folder of the plugin. | Nothing. |
|
Blocked files missing at the target: … |
The listed files of the backup are no longer at the target. | Restore another backup. If the same backup is still stored at a second target, the command line reads it from there with --target. |
|
Blocked files with a different size at the target: … |
The listed files do not have the size recorded in the backup. | As in the row before. Check backup reads the backup in full and marks it in the list. If it fails at this target, the next pre-check reads from another target where it is stored completely. |
|
Blocked the info file at the target is not the one this website stored for this backup; the backup has been changed or replaced there |
When it wrote the backup, the website remembered its info file. The target now holds a different one. | Restore another backup, or read the same backup from another target. |
|
Blocked the backup is encrypted and this website has no key for it; enter the recovery key |
The dialog window Encrypted backup asks for the recovery key. | Enter the recovery key. After that the pre-check runs again. More about this: Encrypt backups. |
|
Blocked the backup is encrypted; opening it needs the plugin cloneworx Backup Pro |
cloneworx Backup Pro is not active. | Activate cloneworx Backup Pro. |
|
Blocked the backup is encrypted and this PHP cannot decrypt it (sodium is missing) |
The server lacks the PHP extension sodium. | Ask your host to enable the PHP extension sodium. |
|
Blocked no complete copy at any target |
The list of backups has no record of any files of the backup at this target. | Restore another backup. |
|
Blocked the info file is missing or unreadable |
The info file describes what is in the backup. Without it the backup cannot be read. | Restore another backup. |
|
Blocked the backup is larger than this 32-bit PHP can handle safely (limit 1.5 GiB) |
The server runs a 32-bit PHP. The pre-check refuses a backup above the limit before the restore changes anything. | Run the website on a 64-bit PHP. |
|
Blocked an English code instead of a sentence |
The target did not answer, or the info file could not be fetched or read. The page has no text of its own for these cases. | Test the target on the Targets page: More …, then Test connection. Then run the pre-check again. |
If the backup cannot be read, points 2 to 8 remain unchecked. They then read Not checked. The page has no text of its own for the finding at these points: it shows an English code instead. Below the points you then also see the note about a different website that point 7 describes.
Unknown backup. If this website does not know the backup because it was found again at a target, imported or written with an earlier version of the plugin, a yellow message is shown below the pre-check: This backup was written with an earlier version of cloneworx Backup. At that time this website did not remember what the backup must look like. So this website cannot check whether the backup was changed or replaced at the storage target. Only confirm the backup as correct if you trust the storage target. Confirm backup as correct permanently remembers the backup as it is at the target now. Cancel closes the preparation. Start restore stays blocked until you have confirmed the backup as correct.
- The point Backup readable and complete has a red dot and blocks the start: files of the backup are missing at the target.
- Points 2 to 8 have a grey dot and are not checked because the backup could not be read. The digit is placed at the middle one of them. The plugin checks the last point, Self-request possible, independently of this.
- The pre-check blocks the start.
- Start restore is blocked.
2. PHP and MySQL version
The plugin compares this website with the values that applied when the backup was made: PHP, type and version of the database server, character set of the database, version of WordPress, table prefix and Multisite. A backup from an older version of the plugin also counts as a difference. For PHP and the database server only the first two parts of the version number count: 8.3 and 8.4 are different, 8.4.1 and 8.4.5 are not. The point never blocks.
| Finding | Meaning | What you can do |
|---|---|---|
|
OK same versions as the backup |
Nothing differs. | Nothing. |
|
Warning … difference(s), listed below |
The list of differences is shown below the points, one per line. | Read the list and check the risk yourself, for example whether your plugins and your theme run with the PHP version of this website. |
3. Free space
The restore builds the files next to the live folders. Every root, for example the plugins or the uploads, therefore needs as much space as its files take up in the backup, plus a small extra amount per file. This is how the plugin calculates:
- Folders on the same disk are added together.
- A reserve always stays free: 256 MiB or 2 % of the disk, whichever is more.
- The work folder of the plugin needs space for two parts of the backup. If the database is part of the scope, the size of its data is added.
- The plugin cannot measure the free space of the database server.
| Finding | Meaning | What you can do |
|---|---|---|
|
OK enough space everywhere |
The space is sufficient at every location. | Nothing. |
|
Not checked free space could not be measured everywhere |
The server does not report the free space for every location. You can still start the restore. | Check the free space with your hosting provider before you start. |
|
Blocked not enough space to build the uploads next to the live folder |
There is enough space for everything else, but not for the uploads. The block No way back appears below the points. | Free up space, or explicitly choose the route without a rollback: Restore uploads when there is not enough space. |
|
Warning the uploads will be replaced in place (no way back) |
You have ticked the route without a rollback. The start is enabled. | Remove the tick again if you do not want this route. |
|
Blocked not enough space for the code roots |
There is not enough space at one location or more, even without counting the uploads. This may also be the work folder of the plugin. | Free up space on the disk, or choose a smaller scope in the Extended view. The pre-check on the command line shows the space per location. |
|
Blocked a root folder is unknown |
The scope includes a root whose folder the plugin cannot determine on this website. | Take this root out of the scope in the Extended view. The page does not say which root it is: remove the ticks one by one until the point no longer blocks the start. |
This is what the pre-check looks like when the server does not report the free space:
- The point Free space has a grey dot. It is followed by the name, the state Not checked and the finding free space could not be measured everywhere.
- Start restore is enabled: a point that is not checked does not block the start.
4. Write permissions at the target folders
“Target folders” here means the folders of the website that the restore writes to, not the targets of the backups. In every chosen root folder the plugin creates its build folder as a test and removes it again. The WordPress root folder must also be writable, even if the core is not part of the scope: the file for the maintenance mode is placed there during the switch-over. If a root folder is missing on this website, for example the folder of the must-use plugins, the restore creates it. The folder above it must be writable for this.
| Finding | Meaning | What you can do |
|---|---|---|
|
OK writable |
The plugin may write into every folder. | Nothing. |
|
Blocked a root folder is not writable |
In one root folder or more the plugin could not create its folder, or a missing root folder cannot be created. | Give the web server write permissions on this folder. The pre-check on the command line shows which folder it is. |
|
Blocked the WordPress root folder is not writable |
The plugin could not create a file in the root folder of the installation. | Give the web server write permissions on the WordPress root folder. |
|
Blocked the plugin has no folder code yet |
The folders of the plugin have a code in their name. The plugin could not create or save this code. | Get help: Get help: support report, troubleshooting and diagnostics. |
5. max_allowed_packet vs. largest row
max_allowed_packet is a setting of the database server: the maximum size of a single statement. The backup records its largest row. This row must fit within the limit with a reserve of 4096 bytes.
| Finding | Meaning | What you can do |
|---|---|---|
|
OK the largest row fits into max_allowed_packet |
Every row of the backup can be inserted. | Nothing. |
|
Blocked a row is larger than max_allowed_packet |
The database server of this website would not accept the largest row of the backup. The plugin cannot restore such a row. | The value can be changed by whoever manages the database server, usually your hosting provider. The rest can be restored without the database: in the Extended view remove the tick at Database. |
|
Not checked could not be read from the database server |
The database server did not report the value. You can still start the restore. | Run the pre-check again. |
|
Blocked the database server could not be reached |
The pre-check could not connect to the database. Points 6 and 8 then show the same finding. | Run the pre-check again. |
6. Collations
A collation defines how the database compares and sorts text. The plugin compares the character sets and collations of all tables and columns of the backup with those that the database server of this website knows. utf8 and utf8mb3 are treated as the same. The point only blocks the start if the database server cannot be reached.
| Finding | Meaning | What you can do |
|---|---|---|
|
OK all character sets and collations are known here |
Nothing has to be replaced. | Nothing. |
|
Warning … replaced, listed below |
The database server does not know everything the backup uses. Below the points you see what the import replaces and with what. | Check the risk yourself. A replaced collation can change sorting and searching. If it considers two values equal that were different before, the import stops at a duplicate key before anything is switched. |
|
Not checked not recorded in this backup (older plugin version); the import checks them |
The backup comes from an older version of the plugin and does not contain the list yet. | Nothing. The import checks this when it creates the tables. |
|
Not checked could not be read from the database server |
The database server did not report its collations. | Run the pre-check again. |
|
Blocked the database server could not be reached |
See point 5. | Run the pre-check again. |
This is how the plugin chooses the replacement: a collation that distinguishes upper and lower case or compares in binary is replaced by the binary collation of its character set. Every other collation is replaced by the default collation of its character set on this server. If the character set itself is missing, the character set of the connection is used.
7. Same website
A backup contains a fingerprint made of the address of the website and its path on the server. The plugin compares it with this installation. The point never blocks, but it changes the defaults of the switches.
| Finding | Meaning | What you can do |
|---|---|---|
|
OK this website |
The backup comes from this installation. By default the WordPress core, the drop-ins and the files .htaccess, web.config and .user.ini are also part of the restore. | Nothing. |
|
Warning a different website |
The backup comes from another website or from another path. By default the WordPress core, the drop-ins and the files .htaccess, web.config and .user.ini are left out. | In the Extended view you can switch on what you want to restore anyway: Restore a backup on another website. |
|
Warning unknown origin (no fingerprint); treated as a different website |
The backup has no fingerprint. The defaults for a different website apply. The backup is never rejected. | As in the row before. |
With both warnings, you see below the points Different website: this backup was made on another site. The site address stays the one of this website.
8. Database rights (probe)
The plugin does not read a list of rights. On throwaway tables it does what the restore will do: create, insert, create an index, a second table with a foreign key, a trigger, a view, rename, drop. Afterwards it removes everything again, even after an error.
| Finding | Meaning | What you can do |
|---|---|---|
|
OK create, insert, index, rename, drop, foreign key, trigger and view work |
The database user is allowed to do everything the restore needs. | Nothing. |
|
Warning foreign key, trigger or view refused; the import leaves them out |
Tables and data can be restored. The import does not create foreign keys, triggers or views and says so in the result. | Check whether your website needs these objects. The rights are granted by whoever manages the database, usually your hosting provider. |
|
Blocked create, insert, index, rename or drop refused |
The database user lacks a right that the restore cannot work without. | Ask your hosting provider for the right. The pre-check on the command line shows at which step the test failed, with the message from the database server. |
|
Blocked the database server could not be reached |
See point 5. | Run the pre-check again. |
9. Self-request possible
After the switch-over the new website has to confirm itself. This point says how that happens: through the self-request, in which the server calls its own address, or through the open page in the browser. The point never blocks.
| Finding | Meaning | What you can do |
|---|---|---|
|
OK the self-request works; the new website confirms itself |
The server can reach itself. | Nothing. |
|
Warning no self-request: keep this page open until the restore is confirmed |
Self-requests do not arrive on this server. The open Restore page confirms the new website instead. | Keep the page open until the restore is finished. Without confirmation the plugin switches everything back after 60 seconds. |
|
Not checked not tested yet |
No self-request has run on this website yet. You can still start the restore. | Keep the page open. To find out whether self-requests arrive, use Check task sources on the Settings page, in the Extended view in the tile Scheduler. |
When the database is not part of the scope
If you remove the tick at Database in the Extended view, points 5, 6 and 8 do not apply. All three then read OK without anything having been checked. The page has no text of its own for the finding: it shows an English code saying that the database is not chosen. The list of differences then does not contain the table prefix, the plugin version or the details about the database server. The pre-check then also does not list the tables of this website that are not in the backup.
- Database is not ticked: the database is not restored.
- The point max_allowed_packet vs. largest row is green without a check: the database is not chosen.
- The same applies to the point Collations.
- The same applies to the point Database rights (probe).
What is shown below the points
- A point with a warning has a yellow dot; state and finding are shown in yellow.
- The list shows the differences between the backup and this website, one per line.
- Replaced on import (unknown to this database server): shows one collation of the backup and its replacement per line.
- Not restored: lists what the restore leaves out, and why.
- The note says that the backup comes from a different website and that the address of this website is kept.
- Start restore stays enabled: warnings do not block the start.
Below the nine points you see what the pre-check found in detail, always in this order. Each part appears only if there is something to report:
- the differences between the backup and this website
- what the import replaces
- what is not restored
- the tables of this website that are not in the backup
- the line about the tables of other WordPress installations in the same database
- the note that the backup comes from a different website
- the block No way back
- the line The pre-check blocks the start.
Differences
Above the list you see Differences between the backup and this website. You judge the risk; the restore goes the best possible way: Every line has the form …: backup …, here …
| Line | What is compared |
|---|---|
| PHP | The PHP version, first two parts of the number. |
| WordPress | The version of WordPress. |
| Table prefix | The prefix of the tables. The import converts the tables of the backup to the prefix of this website. |
| Multisite | The line appears if the backup or this website is a Multisite. Multisite is not supported: the backup contains only the tables of the main website. The values are given in English: yes or no. |
| Plugin version | The backup comes from an older version of the plugin. Such a backup may lack columns whose default is an expression; the import lists them, and they get their default value. |
| Database | The type of database server: MySQL or MariaDB. |
| Database version | The version of the database server, first two parts of the number. |
| Table names that differ only in their case | The backup contains tables whose names differ only in upper and lower case. These names follow “backup”; “here” is followed by the setting lower_case_table_names of the database server. |
| Database character set | The character set of the database server. |
If the database server does not know a character set or a collation of the backup, that is in the list as well. These lines begin with the English word charset or collation.
Replaced on import
The list appears if the import has to replace a collation. The point Collations then shows a warning. Every line shows the collation of the backup on the left and, after the arrow on the right, the replacement that the import uses. The list shows at most 50 entries.
Not restored
The line lists every root and every file that the restore leaves out, with the reason in brackets.
| Reason | Meaning |
|---|---|
| never restored | Applies to this plugin with its folders and tables. |
| not in the backup | This backup does not contain the chosen root. |
| WordPress core not chosen | The switch Do not restore WordPress core is ticked. |
| left out by your choice | You have deselected the drop-ins or the files .htaccess, web.config and .user.ini. |
| left out on a different website by default | The backup comes from a different website. Drop-ins and the files .htaccess, web.config and .user.ini are left out as long as you do not switch them on. |
| the web root cannot be determined here (WordPress is not in its own subfolder with its own address) | Applies to Web root files: the backup comes from a website where WordPress lives in its own subfolder with its own address. This website has no such web root. |
The file wp-config.php is never part of a backup, and a restore leaves the wp-config.php of this website as it is.
Tables that are not in the backup
If the database belongs to the scope, the pre-check searches the database for tables with the table prefix of this website that the backup does not contain, for example because a plugin created them only after the backup. If the pre-check finds such tables, Not restored: is followed by a separate block with their names.
- Tables of this website that are not in the backup; they stay: This is the heading of the block as long as the restore does not remove these tables.
- The line lists the names of these tables.
- The line Tables of other installations under this prefix stay untouched: … lists the prefixes of these installations.
- The tables of the plugin itself are not included.
- The block lists at most 50 names. Three dots at the end mean that there are more.
- The block is not a point of the pre-check: it neither warns nor blocks the start.
The heading of the block says what happens to these tables. That depends on the switch Remove everything that is not in the backup, which is shown in the Extended view:
| Heading of the block | Meaning |
|---|---|
| Tables of this website that are not in the backup; they stay: | The switch is not ticked. The restore does not touch these tables. |
| Tables of this website that are not in the backup; they are removed, “Undo restore” brings them back: | The switch is ticked. During the switch-over the restore moves these tables to the previous state. Undo restore brings them back, Delete the way back deletes them permanently. |
The line Tables of other installations under this prefix stay untouched: … appears if the same database holds another WordPress installation whose table prefix begins with the prefix of this website, for example wp_shop_ next to wp_. The plugin recognises such an installation by the fact that the tables “options” and “posts” exist under the longer prefix, for example wp_shop_options and wp_shop_posts. The tables of such an installation are never treated as tables of this website: the restore does not touch them, even with the switch. The line is shown even if the block above it is not.
The pre-check does not show which files the switch removes: the files are only counted by the restore itself. More on the switch: The “Restore” page.
When a point blocks
- The point that blocks the start has a red dot; state and finding are shown in red.
- The pre-check blocks the start.
- Start restore is blocked.
Fix the cause and click Run pre-check. Once no point blocks the start any more, Start restore is enabled.
No rollback: the uploads do not fit next to the live folder
- The point Free space blocks the start.
- No way back is the title of the block, with a warning triangle in front of it. Below it you read what cannot be undone. A second sentence says that files that are not in the backup remain unchanged.
- Replace uploads in place anyway (cannot be undone) selects this route. The checkbox is unticked by default.
- The pre-check blocks the start.
- Start restore is blocked as long as the checkbox is not ticked.
This route cannot be undone
The block reads: There is not enough space to build the uploads next to the live folder. Replacing files in place cannot be undone: every file from the backup overwrites the existing one without a copy of the previous state. Cancel is the default. If you tick the checkbox, the pre-check runs again. The point Free space then no longer blocks the start; it shows a warning instead. More on this: Restore uploads when there is not enough space.
The block No way back contains a second sentence below that: Files that are not in the backup remain unchanged. “Remove everything that is not in the backup” is off on this way. On this route the overwritten versions of your uploads are lost: the plugin writes every upload file from the backup over the file of the same name. If you have ticked the checkbox, the switch Remove everything that is not in the backup has no effect for the whole restore: files in the root folder and tables that are not in the backup stay as well. In the Extended view the switch is then unticked and blocked.
When the pre-check does not complete
- The note is shown in place of the switches: the defaults are not determined yet. Only the Extended view shows this note.
- Run pre-check starts the pre-check again.
- The message from the server gives the cause, in red.
- not checked yet is shown at every point.
| Message | What you can do |
|---|---|
| This backup is complete at no target. | The backup is no longer stored completely at any configured target, for example because the target was removed. Restore another backup. |
| This backup does not exist. | The backup is no longer in the list. Reload the page and choose a backup from the list. |
| another message | Click Run pre-check. |
See also
- The “Restore” page
- Restore the website from a backup
- Restore only parts
- Restore a backup on another website
- Restore and import with WP-CLI
On the command line
WP-CLI not set up yet? How to install WP-CLI.
The pre-check also runs with WP-CLI and writes nothing to the website while doing so. The output is in English: one line per point with state and finding, then what is not restored, then the tables of this website that are not in the backup, then the differences. The line about these tables says whether they stay or go to the previous state with --remove-extras. The output contains details that the page does not show: the root folder without write permission, the space per location, the table with the largest row and the step at which the test of the database rights failed. If a point blocks the start, the command ends with an error.
# Show the backups with their job names wp cloneworx-backup backup list # Run the pre-check for a backup wp cloneworx-backup restore precheck <Job> # Read the backup from a specific target wp cloneworx-backup restore precheck <Job> --target=local-1 # Check only database and uploads wp cloneworx-backup restore precheck <Job> --roots=db,wp-uploads # Include what another website leaves out by default wp cloneworx-backup restore precheck <Job> --include-core --include-dropins --include-htaccess # Choose the path without rollback for the uploads wp cloneworx-backup restore precheck <Job> --uploads-in-place # Check with: remove everything that is not in the backup wp cloneworx-backup restore precheck <Job> --remove-extras