This is a feature plugin for testing automatic rollback of a plugin or theme update failure.
It is based on #51857, PR #2225 and PR #3958 for inclusion to core.
- When updating a plugin/theme, the old version of the plugin/theme gets moved to a
wp-content/upgrade-temp-backup/themes/THEMENAMEfolder. The reason we chose to move instead of zip, is because zipping/unzipping are very resources-intensive processes, and would increase the risk on low-end, shared hosts. Moving on the other hand is performed instantly and won’t be a bottleneck.
- If the update fails, then the “backup” we kept in the
upgrade-temp-backupfolder gets restored to its original location
- If the update succeeds, then the “backup” is deleted
- 2 new checks were added in the site-health screen:
- Check to make sure that the rollbacks folder is writable.
- Check there is enough disk-space available to safely perform updates.
To avoid confusion: The “upgrade-temp-backup” folder will NOT be used to “rollback” a plugin to a previous version after an update. This folder will simply contain a transient backup of the previous version of a plugins/themes getting updated, and as soon as the update process finishes, the folder will be empty.
- If the
wp-content/upgrade-temp-backupfolder is not writable, there should be an error in the site-health screen.
- If the server has less than 20MB available, there should be an error in the site-health screen that updates may fail.
- If the server has less than 100MB, it should be a notice that disk space is running low.
- When updating a plugin, you should be able to see the old plugin in the
wp-content/upgrade-temp-backup/plugins/PLUGINNAMEfolder. The same should apply for themes. Since updates sometimes run fast and we may miss the folder creation during testing, you can simulate an update failure to demonstrate. This will return early and skip deleting the backup on update-success.
- When a plugin update fails, the previous version should be restored. To test that, change the version of a plugin to a previous number, run the update, and on fail the previous version (the one where you changed the version number) should still be installed on the site. To simulate an update failure and confirm this works, use the built-in Simulate failure link. Just activate/deactivate from the
plugins.phppage action link. This link will only be present if the plugin has an update pending.
Please submit issues and PRs to GitHub.
Logo from a meme generator. Original artwork by Allie Brosh.
Contributors & Developers
“Rollback Update Failure” is open source software. The following people have contributed to this plugin.Contributors
“Rollback Update Failure” has been translated into 7 locales. Thank you to the translators for their contributions.
Translate “Rollback Update Failure” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Please see the Github repository: CHANGELOG.md.
5.3.0 / 2023-05-21
- improved language for email
- put guard for Rollback part 2 not being committed back
- add theme update data to failure email
5.2.0 / 2023-05-09
- restart theme auto-updates
- remove guard for Rollback not being committed
- set Plugin_Upgrader via hook
- cleanup Plugin_Upgrader hook from fatal update
5.1.1 / 2023-05-05
- update readme
5.1.0 / 2023-05-03
- align docblocks with PR
- update for Rollback committed to core
5.0.6 / 2023-04-25
- update code logic for creating
temp-backupdir, thanks @azaozz
5.0.5 / 2023-04-14
- hotfix for no autoload
5.0.4 / 2023-04-14
- update tests
- update GitHub Actions
- ignore vendor directory
5.0.3 / 2023-03-22
- update @since
- update using constant to check version for when
- update using constant to check version for when
- update for PR compatibility
- developery stuff
5.0.2 / 2023-02-05
- make variables static to retain value during auto-updater run
5.0.1 / 2023-02-03
move_dir()called with 3rd parameter as
move_dir($from, $to, true)
5.0.0 / 2023-02-02
WP_Rollback_Auto_Update::restart_updatesremove shutdown hook for
- skip second sequential call to
- now require at least WP 6.2-beta1, deactivate if requirements not met
- Faster Updates no longer required as committed to core
4.1.2 / 2023-01-25
move_dir()for new parameter
4.1.1 / 2023-01-20
- ensure specific functions are loaded to check for Faster Updates
4.1.0 / 2023-01-19
- change directory name of rollback to distinguish from update.
- update for
4.0.0 / 2023-01-10
upgrade_pluginstransient to object, overkill but someone reported an error
- merge Rollback Auto Update
- require Faster Updates for
- no longer requires special filter in
- testing only on
3.3.2 / 2022-12-30
- update for new filter hook in WP_Upgrader::install_package
- update nonce verification for failure simulator
3.3.1 / 2022-10-25
array_uniquewhen saving simulated failure options
- load failure simulator in
inithook for WP-CLI
3.3.0 / 2022-10-14
WP_Upgrader::unpack_packagedeletes contents of
wp-content-upgradeat each update
- add simulated failure into plugin
3.2.1 / 2022-09-23
- bump auto-deactivation check for WP version
3.2.0 / 2022-09-19
- backup runs on
upgrader_pre_installto resolve an edge case
- rename functions for action not hook
3.1.1 / 2022-07-31
- update VirtualBox testing URL in readme(s)
3.1.0 / 2022-06-27
- fix to ensure restore functions correctly during bulk update
3.0.0 / 2022-06-14
- remove references to VirtualBox
- use with VirtualBox environment will require a mu-plugin and a watcher script or similar for VirtualBox based environments
- update error messaging in
2.2.0 / 2022-05-11
- add initial setup of weekly
wp_delete_temp_updater_backupscron task, oops
2.1.2 / 2022-05-11
wp_delete_all_temp_backups()for plugin namespace, not for PR
2.1.1 / 2022-05-11
- update testing workflows
- fix action hook
wp_delete_temp_updater_backupsfor plugin namespace, not for PR
2.1.0 / 2202-04-12
- pass basename of destination to
copy_dir( $skip_list )to avoid potential endless looping.
2.0.0 / 2022-04-06
- refactor to ease PR back into core by separating out changes into respective files/classes
1.5.0 / 2022-04-04
- remove anonymous callbacks
- add class
$optionsfor callback functions
- add testing scaffold
1.4.0 / 2022-04-03
- move kill switch to WP6.1-beta1
- add non-direct filesystem rename variants to
- bring into alignment with PR
1.3.6 / 2022-03-31
- update credit
1.3.5 / 2022-03-31
- add more Site Health info for runtime environment
1.3.4 / 2022-03-21
1.3.3 / 2022-03-18
wp_get_runtime_environment()to return value of constant
- allowed values are obviously up for discussion
- update to most of current PR
1.3.2 / 2022-02-15
- update to correspond to core patch
1.3.1 / 2022-01-19
- add logo credit, Logo from a meme generator. Original artwork by Allie Brosh.
1.3.0 / 2021-01-12
is_virtual_box()to get whether running in VirtualBox, requires
define( 'ENV_VB', true )or
genenv( 'WP_ENV_VB' )evaluating to true
rename()as VirtualBox gets borked when using
1.2.0 / 2021-12-17
- updated for more parity with planned code
- updated version check for revert
- update to use
1.1.3 / 2021-09-17
- update version check
1.1.1 / 2021-09-07
- update check for
1.1.0 / 2021-09-01
- automatically deactivate plugin after feature committed to core, currently set to
- check for disabled function
disk_free_space()and degrade gracefully
1.0.0 / 2021-08-30
- updated to be on par with PR #1492, thanks @aristah
- original zip rollback is now branch zip-rollback
0.5.3 / 2021-07-01
- add @10up GitHub Actions integration for WordPress SVN
0.5.2 / 2021-06-10
- exit early if
0.5.1 / 2021-03-15
- update error message for installation not update
0.5.0 / 2021-02-10
- initial commit
- use simpler hook for
- update for
upgrader_install_package_resultfilter and parameters passed
- add text domain
- update error message display
- added filter
rollback_update_testingto simulate a failure.
- override filter if there’s already a WP_Error