Àpèjúwe
You are developing things on a WordPress site and would like to have a snapshot of the current state of your site? SnapShots will help you save states of your WordPress environment.
- Save snapshots of your site with a simple click.
- Name your snapshots for easy distinction.
- SnapShots stores current location and redirects after restore.
- Stores and restores database tables and files in upload folder.
- Automatically logs in current user.
- Automatically clears old snapshots with same name.
- Small footprint and minimal UI.
Options
All options are defined via constants and can get overwritten with a filter. The format of options is
SNAPSHOTS_[OPTION_NAME]
Best to define your custom option constants in the wp-config.php file.
You can use filters options like
add_filter( 'snapshots_[option_name]', function( $default_option ){
return $my_option;
});
Default Options
// Default save location.
SNAPSHOTS_FOLDER : WP_CONTENT_DIR . '/.snapshots'
// add '--allow-root' to each command if you run the commands as root.
SNAPSHOTS_CLI_ALLOW_ROOT: false
// define the location of your 'wp' binaries.
SNAPSHOTS_CLI_PATH: '/usr/local/bin'
// Number of shots kept with the same name.
SNAPSHOTS_MAX_SHOTS: 2
// SnapShot includes files from content folder.
SNAPSHOTS_SAVE_FILES: true
// SnapShot includes location (URL) during creation to redirect on restore.
SNAPSHOTS_SAVE_LOCATION: true
Ìgbéwọlẹ̀
- Upload
snapshoststo the/wp-content/plugins/directory. - Activate the plugin through the ‘Plugins’ menu in WordPress.
- Click on “Click here to create your first Snapshot!” in the admin bar to create your first Snapshot.
- Restore the saved snapshot by clicking on the menu entry and confirm.
- All tables not used in the current SnapShot with the DB prefix will be removed!
FAQ
-
What are the requirements for SnapShots
-
You need WP CLI installed (at least version 2.2) and PHP must be able to execute external programs with PHPs
exec -
Does it work without WP CLI?
-
No, WP CLI is essential here and SnapShots will not work without it. You will not be able to activate the plugin without the addon.
-
Does it work with “Local”
-
Yes, the plugin has been tested with the amazing tool from WPEngine and works out of the box.
-
Snapshots requires the php in your PATH environment
-
SnapShots tries to find the
phpbinary on your system. If it canÌtumọ̀ Yorùbá: ’t find it, you will get this error. You can define the location of yourphpbinary by open your terminal and running`dirname $(which php)
`This returns the directory of your php binary. Use this location to define the constant
SNAPSHOTS_PHP_PATHin yourwp-config.phpfile. For example:`define( ‘SNAPSHOTS_PHP_PATH’, ‘/usr/local/bin’ );
`DonÌtumọ̀ Yorùbá: ’t include the
phpbinary in the path! -
Your Home URLs do not match
-
Snapshots checks if the home URL of your site matches the one from
wp option get home. If they are not equal it often that theDB_HOSTvariable is not defined correctly. This also happens if you use a socket for your MySql connection (Local WP).Update your DB_HOST variable in your
wp-config.phpfile to something like this:`define( ‘DB_HOST’, ‘localhost:/tmp/ysql/mysqld.sock’ );
`This should not affect the regular usage of your site. If you encounter any problems, You can wrap the statement like so:
`if ( defined( ‘WP_CLI’ ) && WP_CLI ) {
define( ‘DB_HOST’, ‘localhost:/tmp/ysql/mysqld.sock’ );
}else{
define( ‘DB_HOST’, ‘localhost’ );
}
` -
Snapshots requires the “exec” method
-
SnapShots uses the PHP
execmethod to execute the WP CLI commands.` -
Snapshots requires WP-CLI!
-
SnapShots requires the WP-CLI to be installed on your system. Please install it and make sure it is available in your
PATHenvironment.
Àwọn àgbéyẹ̀wò
Àwọn Olùkópa & Olùgbéejáde
“SnapShots” jẹ́ ètò ìṣàmúlò orísun ṣíṣí sílẹ̀. Àwọn ènìyàn wọ̀nyí ti ṣe ìkópa sí plugin yìí.
Àwọn Olùkópa
Ṣe o nífẹ̀ẹ́ sí ìdàgbàsókè?
Ṣàwárí koodu, ṣàyẹ̀wò ibi ìpamọ́ SVN, tàbí ṣe àgbékalẹ̀ sí àkọsílẹ̀ ìdàgbàsókè nípasẹ̀ RSS.
Àkọsílẹ̀ àwọn àyípadà
2.8.2
- instructions for namespaces
- update github workflow, no actual changes to the plugin
2.8.1
- updated file strucutre
2.8.0
- Tested up to PHP 8.3
- fixed: redirects now work with fragments in URLs
- change: current snapshot names is now stored in the database (not in the localstorage anymore)
2.7.0
- better error handling
- keyboard search
- tested up to 6.1
- implemented upgrade mechanism for future update routines
2.6.0
- fixed: Snapshots with numbers are now recognized.
- moved to external script and styles
2.5.0
- store last use snapshots in localstorage
2.4
- Now requires at least PHP 7.0
2.3
- updated usage of CLI commands for better support
2.2
- checks for ZIPAchive and falls back to PCLZIP if not available
- automatically checks the
home_urland do asearch-replaceif necessary
2.1
- Updated look in the dropdown menu.
2.0
- Breaking changes: Snapshosts are now stored in a subdirectory.
- added option to remove snapshots from the UI
1.0
- Initial release