PluginProbe ʕ •ᴥ•ʔ
WP STAGING – WordPress Backup, Restore, Migration & Clone / 4.9.1
WP STAGING – WordPress Backup, Restore, Migration & Clone v4.9.1
4.9.1 4.9.0 4.8.1 trunk 3.0.0 3.0.1 3.0.2 3.0.3 3.0.4 3.0.5 3.0.6 3.1.0 3.1.1 3.1.2 3.1.3 3.1.4 3.10.0 3.2.0 3.3.1 3.3.2 3.3.3 3.4.1 3.4.3 3.5.0 3.6.0 3.7.1 3.8.0 3.8.1 3.8.2 3.8.3 3.8.4 3.8.5 3.8.6 3.8.7 3.9.0 3.9.1 3.9.2 3.9.3 3.9.4 4.0.0 4.1.0 4.1.1 4.1.2 4.1.3 4.1.4 4.2.0 4.2.1 4.3.0 4.3.1 4.3.2 4.4.0 4.5.0 4.6.0 4.7.0 4.7.1 4.7.2 4.7.3 4.8.0
wp-staging / uninstall.php
wp-staging Last commit date
Backend 1 day ago Backup 1 week ago Basic 1 week ago Component 1 week ago Core 1 week ago Framework 1 day ago Frontend 5 months ago Notifications 8 months ago Staging 1 day ago assets 1 day ago languages 1 day ago resources 1 year ago vendor_wpstg 1 week ago views 1 day ago CONTRIBUTING.md 1 year ago Deactivate.php 8 months ago README.md 3 months ago SECURITY.md 2 years ago autoloader.php 1 month ago bootstrap.php 1 month ago commonBootstrap.php 1 day ago constantsFree.php 1 day ago freeBootstrap.php 1 month ago install.php 1 week ago opcacheBootstrap.php 1 day ago readme.txt 1 day ago runtimeRequirements.php 3 months ago uninstall.php 1 week ago wp-staging-error-handler.php 6 months ago wp-staging.php 1 day ago
uninstall.php
613 lines
1 <?php
2
3
4 if (!defined('WP_UNINSTALL_PLUGIN')) {
5 exit;
6 }
7
8 /**
9 * Handles plugin uninstallation and cleanup of WP Staging data
10 *
11 * This class manages the complete uninstallation process including:
12 * - Detecting single site vs multisite/network uninstall scenarios
13 * - Distinguishing between Basic and Pro version uninstallation
14 * - Preserving data when both versions are installed
15 * - Cleaning up options, transients, and cron events
16 * - Removing plugin directories (except those containing backups)
17 * - Respecting user's "Remove Data on Uninstall" setting
18 *
19 * The class runs in standalone context without the plugin's autoloader,
20 * so it must be self-contained with no external dependencies.
21 *
22 * Note: Avoids using class constants to prevent loading the whole plugin.
23 * @package WPSTG
24 * @subpackage Uninstall
25 * @copyright Copyright (c) 2015, René Hermenau
26 * @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
27 * @since 0.9.0
28 */
29 class Uninstall
30 {
31 /**
32 * Options we want to preserve.
33 * These should remain until we have a staging site deletion routine.
34 */
35 private $preserveOptions = [
36 'wpstg_existing_clones',
37 'wpstg_existing_clones_beta',
38 'wpstg_staging_sites',
39 'wpstg_connection',
40 ];
41
42 public function __construct()
43 {
44 if (!is_multisite()) {
45 $this->runForSingleSite(); // Normal single-site uninstall
46 return;
47 }
48
49 if ($this->isNetworkUninstall()) {
50 $this->runForNetwork(); // Full cleanup across all sites + network data
51 } else {
52 $this->runForSingleSite(); // Only clean current subsite
53 }
54 }
55
56 /**
57 * @return void
58 */
59 private function runForNetwork()
60 {
61 $siteIds = get_sites(['fields' => 'ids']);
62 foreach ($siteIds as $siteId) {
63 switch_to_blog($siteId);
64 $this->runForSingleSite();
65 restore_current_blog();
66 }
67
68 $this->deleteNetworkOptions();
69 }
70
71 /**
72 * @return void
73 */
74 private function runForSingleSite()
75 {
76 $settings = $this->getSettings();
77
78 if (empty($settings['unInstallOnDelete']) || $settings['unInstallOnDelete'] !== '1') {
79 return;
80 }
81
82 // If Pro is installed, no matter if active or not, and we're uninstalling Basic, do nothing to preserve all data.
83 // This is to make sure pro version still works once user installs free version again in case he only temporary uninstalled it.
84 if ($this->isProInstalled() && $this->isUninstallingBasic()) {
85 return;
86 }
87
88 // If Basic is installed, and we're uninstalling Pro, remove only Pro data
89 if ($this->isBasicInstalled() && $this->isUninstallingPro()) {
90 $this->deleteOptions($this->getProOptions());
91 return;
92 }
93
94 // If Basic not installed, and we're uninstalling Pro, remove all data
95 if (!$this->isBasicInstalled() && $this->isUninstallingPro()) {
96 $this->performCompleteCleanup(true);
97 return;
98 }
99
100 // If Pro not installed, and we're uninstalling Basic, remove all data
101 if (!$this->isProInstalled() && $this->isUninstallingBasic()) {
102 $this->performCompleteCleanup(false);
103 }
104 }
105
106 /**
107 * @param bool $isPro
108 * @return void
109 */
110 private function performCompleteCleanup(bool $isPro)
111 {
112 $this->deleteOptions($this->getBasicOptions());
113 if ($isPro) {
114 $this->deleteOptions($this->getProOptions());
115 }
116
117 $this->deleteUserMeta($this->getBasicUserMeta());
118 $this->dropWpStagingSettingsTable();
119 $this->deleteTransients();
120 $this->cleanupEmptyPreserveOptions();
121 $this->clearCronEvents();
122 $this->cleanupWpStagingDirectories();
123 }
124
125 /**
126 * @return void
127 */
128 private function dropWpStagingSettingsTable()
129 {
130 global $wpdb;
131
132 if (!($wpdb instanceof \wpdb)) {
133 return;
134 }
135
136 $tableName = str_replace('`', '', $wpdb->prefix . 'wpstg_settings');
137 $wpdb->query("DROP TABLE IF EXISTS `{$tableName}`");
138 }
139
140 /**
141 * @return bool
142 */
143 private function isNetworkUninstall(): bool
144 {
145 return (is_multisite() && is_network_admin());
146 }
147
148 /**
149 * @return bool
150 */
151 private function isUninstallingBasic(): bool
152 {
153 $pluginDirs = ['wp-staging', 'wp-staging-1'];
154 return $this->isUninstallingPlugin($pluginDirs);
155 }
156
157 /**
158 * @return bool
159 */
160 private function isUninstallingPro(): bool
161 {
162 $pluginDirs = ['wp-staging-pro', 'wp-staging-pro-1'];
163 return $this->isUninstallingPlugin($pluginDirs);
164 }
165
166 /**
167 * @param array $pluginDirs
168 * @return bool
169 */
170 private function isUninstallingPlugin(array $pluginDirs): bool
171 {
172 return in_array(basename(__DIR__), $pluginDirs);
173 }
174
175 /**
176 * @return bool
177 */
178 private function isProInstalled(): bool
179 {
180 // First try header-based detection (more robust)
181 if ($this->isProInstalledByHeaders()) {
182 return true;
183 }
184
185 // Fallback to file-based detection for backward compatibility
186 $plugins = [
187 'wp-staging-pro-1/wp-staging-pro.php',
188 'wp-staging-pro/wp-staging-pro.php',
189 ];
190 foreach ($plugins as $plugin) {
191 if ($this->isPluginInstalled($plugin)) {
192 return true;
193 }
194 }
195
196 return false;
197 }
198
199 /**
200 * @return bool
201 */
202 private function isBasicInstalled(): bool
203 {
204 // First try header-based detection (more robust)
205 if ($this->isBasicInstalledByHeaders()) {
206 return true;
207 }
208
209 // Fallback to file-based detection for backward compatibility
210 $plugins = [
211 'wp-staging-1/wp-staging.php',
212 'wp-staging/wp-staging.php',
213 ];
214 foreach ($plugins as $plugin) {
215 if ($this->isPluginInstalled($plugin)) {
216 return true;
217 }
218 }
219
220 return false;
221 }
222
223 /**
224 * @param $pluginName
225 * @return bool
226 */
227 private function isPluginInstalled($pluginName): bool
228 {
229 return file_exists( WP_PLUGIN_DIR . '/' . $pluginName );
230 }
231
232 /**
233 * @param array $identifiers
234 * @return bool
235 */
236 private function findPluginByIdentifiers(array $identifiers): bool
237 {
238 if (!function_exists('get_plugins')) {
239 require_once ABSPATH . 'wp-admin/includes/plugin.php';
240 }
241
242 $plugins = get_plugins();
243 $searchCriteria = array_change_key_case($identifiers, CASE_LOWER);
244
245 foreach ($plugins as $file => $data) {
246 $name = strtolower($data['Name'] ?? '');
247 $slug = strtolower(dirname($file));
248 $mainFile = strtolower(basename($file, '.php'));
249
250 if (isset($searchCriteria['file']) && strtolower($searchCriteria['file']) === strtolower($file)) {
251 return true;
252 }
253
254 if (isset($searchCriteria['slug']) && ($slug === $searchCriteria['slug'] || $mainFile === $searchCriteria['slug'])) {
255 return true;
256 }
257
258 if (isset($searchCriteria['name']) && $name === strtolower($searchCriteria['name'])) {
259 return true;
260 }
261 }
262
263 return false;
264 }
265
266 /**
267 * @return bool
268 */
269 private function isBasicInstalledByHeaders(): bool
270 {
271 return $this->findPluginByIdentifiers([
272 'slug' => 'wp-staging',
273 'name' => 'WP Staging',
274 'file' => 'wp-staging/wp-staging.php',
275 ]);
276 }
277
278 /**
279 * @return bool
280 */
281 private function isProInstalledByHeaders(): bool
282 {
283 return $this->findPluginByIdentifiers([
284 'slug' => 'wp-staging-pro',
285 'name' => 'WP Staging Pro',
286 'file' => 'wp-staging-pro/wp-staging-pro.php',
287 ]);
288 }
289
290 /**
291 * @return array
292 */
293 private function getSettings(): array
294 {
295 return json_decode(json_encode(get_option('wpstg_settings', [])), true) ?? [];
296 }
297
298 /**
299 * @return string[]
300 */
301 private function getBasicOptions(): array
302 {
303 return [
304 'wpstg_settings',
305 'wpstg_clone_settings',
306 'wpstg_free_install_date',
307 'wpstg_installDate',
308 'wpstg_version',
309 'wpstg_version_upgraded_from',
310 'wpstg_free_upgrade_date',
311 'wpstg_rating',
312 'wpstg_rating_snooze_count',
313 'wpstg_unique_identifier',
314 'wpstg_is_staging_site',
315 'wpstg_resave_permalinks_executed',
316 'wpstg_rmpermalinks_executed',
317 'wpstg_connection',
318 'wpstg_staging_sites',
319 'wpstg_existing_clones',
320 'wpstg_existing_clones_beta',
321 'wpstg_execute',
322 'wpstg_emails_disabled',
323 'wpstg_woo_scheduler_disabled',
324 'wpstg_clone_excluded_files_list',
325 'wpstg_clone_excluded_gd_files_list',
326 'wpstg_freemius_notice',
327 'wpstg_queue_table_structure_version',
328 'wpstg_settings_table_version',
329 'wpstg_q_feature_detection_ajax_available',
330 'wpstg_analytics_has_consent',
331 'wpstg_analytics_modal_dismissed',
332 'wpstg_analytics_notice_dismissed',
333 'wpstg_analytics_consent_remind_me',
334 'wpstg_default_color_mode',
335 'wpstg_default_os_color_mode',
336 'wpstg_last_backup_info',
337 'wpstg_backups_retention',
338 'wpstg_otps',
339 'wpstg_access_token',
340 'wpstg_disabled_notice',
341 'wpstg_send_email_as_html',
342 'wpstg_cli_notice_hidden_forever',
343 'wpstg_cli_dock_cta_shown',
344 'wpstg_completed_upgrades',
345 ];
346 }
347
348 /**
349 * Per-user meta keys written by the Free/shared code, removed for every user.
350 *
351 * @return string[]
352 */
353 private function getBasicUserMeta(): array
354 {
355 return [
356 'wpstg_user_general_pro_card_snoozed_until',
357 ];
358 }
359
360 /**
361 * @return string[]
362 */
363 private function getProOptions(): array
364 {
365 return [
366 'wpstgpro_version',
367 'wpstgpro_version_upgraded_from',
368 'wpstgpro_install_date',
369 'wpstgpro_upgrade_date',
370 'wpstg_license_key',
371 'wpstg_license_status',
372 'wpstg_pro_latest_version',
373 'wpstg_googledrive', //Legacy
374 'wpstg_google-drive',
375 'wpstg_dropbox',
376 'wpstg_one-drive',
377 'wpstg_pcloud',
378 'wpstg_amazons3', //Legacy
379 'wpstg_amazon-s3',
380 'wpstg_sftp',
381 'wpstg_digitalocean', //Legacy
382 'wpstg_digitalocean-spaces',
383 'wpstg_wasabi', //Legacy
384 'wpstg_wasabi-s3',
385 'wpstg_generic-s3',
386 'wpstg_backup_schedules',
387 'wpstg_backup_schedules_send_error_report',
388 'wpstg_backup_schedules_report_email',
389 'wpstg_backup_schedules_send_slack_error_report',
390 'wpstg_backup_schedules_report_slack_webhook',
391 'wpstg_current_site_login_links',
392 'wpstg_remote_sync_api_token',
393 'wpstg_remote_sync_password',
394 ];
395 }
396
397 /**
398 * @return string[]
399 */
400 private function getAllTransients(): array
401 {
402 return [
403 'wpstg_current_job',
404 'wpstg_rest_url',
405 'wpstg.run_daily',
406 'wpstg_show_login_notice',
407 'wpstg_user_logged_in_status',
408 'wpstg_auto_login_failed',
409 'wpstg_auto_login_failed_reason',
410 'wpstg_failed_auto_login_attempts',
411 'wpstg_otp_sent',
412 'wpstg_otp_consecutive_failures',
413 'wpstg_otp_locked',
414 'wpstg_redirect_url',
415 'wpstg_remote_sync_session',
416 'wpstg_remote_sync_session_data',
417 'wpstg_remote_sync_session_events_offset',
418 'wpstg.queue.request.get_method',
419 'is_invalid_backup_file_index',
420 'wpstg_permalinks_do_purge',
421 'wpstg_purge_litespeed_cache',
422 'wpstg_activation_redirect',
423 'wpstg_pro_activation_redirect',
424 'wpstg_weekly_version_update',
425 'wpstg_rate_limit_update_check',
426 'wpstg_issue_report_submitted',
427 'wpstg.backup.schedules.slack_report_sent',
428 'wpstg_email_notification_access_token',
429 'wpstg.directory_listing.last_checked',
430 ];
431 }
432
433 /**
434 * @param array $optionNames
435 * @return void
436 */
437 private function deleteOptions(array $optionNames)
438 {
439 foreach ($optionNames as $optionName) {
440 // Skip if this option should be preserved
441 if (in_array($optionName, $this->preserveOptions, true)) {
442 continue;
443 }
444
445 delete_option($optionName);
446 }
447 }
448
449 /**
450 * Delete the given user meta keys for every user on the site.
451 *
452 * @param string[] $metaKeys
453 * @return void
454 */
455 private function deleteUserMeta(array $metaKeys)
456 {
457 foreach ($metaKeys as $metaKey) {
458 delete_metadata('user', 0, $metaKey, '', true);
459 }
460 }
461
462 /**
463 * @return void
464 */
465 private function deleteTransients()
466 {
467 $transients = $this->getAllTransients();
468 foreach ($transients as $transientName) {
469 delete_transient($transientName);
470 }
471 }
472
473 /**
474 * @return void
475 */
476 private function cleanupEmptyPreserveOptions()
477 {
478 $this->cleanupEmptyOptions($this->preserveOptions);
479 }
480
481 /**
482 * @param array $options
483 * @param bool $isSiteOptions
484 * @return void
485 */
486 private function cleanupEmptyOptions(array $options, bool $isSiteOptions = false)
487 {
488 foreach ($options as $option) {
489 $value = $isSiteOptions ? get_site_option($option): get_option($option);
490 if (empty($value)) {
491 $isSiteOptions ? delete_site_option($option): delete_option($option);
492 }
493 }
494 }
495
496 /**
497 * @return void
498 */
499 private function clearCronEvents()
500 {
501 // @see WPStaging\Core\Cron\Cron::ACTION_WEEKLY_EVENT
502 wp_clear_scheduled_hook('wpstg_weekly_event');
503 }
504
505 /**
506 * @return void
507 */
508 private function cleanupWpStagingDirectories()
509 {
510 $uploadsBase = $this->getUploadsDirectory() . 'wp-staging/';
511 $directoriesToClean = [
512 $this->getWpContentDirectory() . 'wp-staging',
513 ];
514
515 // Delete wp-staging uploads dir if it does not contain .wpstg files
516 if (!$this->isDirectoryContainsWpstgFiles($uploadsBase . 'backups')) {
517 $directoriesToClean[] = $uploadsBase;
518 } else {
519 $directoriesToClean[] = $uploadsBase . 'cache';
520 $directoriesToClean[] = $uploadsBase . 'logs';
521 $directoriesToClean[] = $uploadsBase . 'tmp';
522 }
523
524 foreach ($directoriesToClean as $directory) {
525 $this->deleteDirectoryRecursively($directory);
526 }
527 }
528
529 /**
530 * @param string $directory
531 * @return void
532 */
533 private function deleteDirectoryRecursively(string $directory)
534 {
535 if (!is_dir($directory)) {
536 return;
537 }
538
539 $absPath = trailingslashit(ABSPATH);
540 if ($directory === $absPath || $directory === dirname($absPath)) {
541 return;
542 }
543
544 foreach (new \DirectoryIterator($directory) as $item) {
545 if ($item->isDot()) {
546 continue;
547 }
548
549 $itemPath = $item->getPathname();
550 if ($item->isDir()) {
551 $this->deleteDirectoryRecursively($itemPath);
552 } else {
553 @unlink($itemPath);
554 }
555 }
556
557 @rmdir($directory);
558 }
559
560 /**
561 * @return void
562 */
563 private function deleteNetworkOptions()
564 {
565 delete_site_option('wpstg_license_key');
566 delete_site_option('wpstg_license_status');
567 delete_site_option('wpstgDisableLicenseNotice');
568 $this->cleanupEmptyOptions($this->preserveOptions, true);
569 }
570
571 /**
572 * @return string
573 */
574 private function getUploadsDirectory(): string
575 {
576 $uploadDir = wp_upload_dir();
577 return trailingslashit($uploadDir['basedir']);
578 }
579
580 /**
581 * @return string
582 */
583 private function getWpContentDirectory(): string
584 {
585 return trailingslashit(WP_CONTENT_DIR);
586 }
587
588 /**
589 * @param string $backupsDir
590 * @return bool
591 */
592 private function isDirectoryContainsWpstgFiles(string $backupsDir): bool
593 {
594 if (!is_dir($backupsDir)) {
595 return false;
596 }
597
598 $iterator = new \RecursiveIteratorIterator(
599 new \RecursiveDirectoryIterator($backupsDir, \FilesystemIterator::SKIP_DOTS)
600 );
601
602 foreach ($iterator as $item) {
603 if ($item->isFile() && strcasecmp($item->getExtension(), 'wpstg') === 0) {
604 return true;
605 }
606 }
607
608 return false;
609 }
610 }
611
612 new Uninstall();
613