← All changes | uninstall.php +186 -48 1.28.0 → 2.7.0 View file →

		@@ -20,33 +20,152 @@
20	20	*
21	21	* Single Responsibility: Handle complete plugin removal
22	22	*/
23	23	class ThinkRank_Uninstaller {
24		-
	24	+
25	25	/**
	26	+ * Option that records a deliberate uninstall.
	27	+ *
	28	+ * Keep in sync with ThinkRank\Core\Activator::UNINSTALLED_OPTION and with
	29	+ * ThinkRank Pro's Free_Plugin_Installer.
	30	+ */
	31	+ private const UNINSTALLED_OPTION = 'thinkrank_uninstalled';
	32	+
	33	+ /**
26	34	* Run uninstall process
27	35	*
28	36	* @return void
29	37	*/
30	38	public static function uninstall(): void {
	39	+ // Everything below resolves through $wpdb->prefix and $wpdb->options,
	40	+ // i.e. the current blog. On a network install WordPress runs this once,
	41	+ // so every other site kept its tables, its options and its stored
	42	+ // credentials — API keys and Google refresh tokens included (#399).
	43	+ if (is_multisite()) {
	44	+ $site_ids = get_sites([
	45	+ 'fields' => 'ids',
	46	+ 'number' => 0,
	47	+ 'update_site_meta_cache' => false,
	48	+ ]);
	49	+
	50	+ foreach ($site_ids as $site_id) {
	51	+ switch_to_blog((int) $site_id);
	52	+ self::uninstall_site();
	53	+ restore_current_blog();
	54	+ }
	55	+
	56	+ return;
	57	+ }
	58	+
	59	+ self::uninstall_site();
	60	+ }
	61	+
	62	+ /**
	63	+ * Remove everything ThinkRank created on the current blog.
	64	+ *
	65	+ * @return void
	66	+ */
	67	+ private static function uninstall_site(): void {
31	68	// Check if user wants to keep data. Default to TRUE (preserve) to match the
32	69	// Settings class default and the documented UI behavior — only nuke data when
33	70	// the user has explicitly enabled "Delete all data on uninstall".
34	71	$keep_data = (bool) get_option('thinkrank_keep_data_on_uninstall', true);
35	72
	73	+ // Files first, and regardless of $keep_data.
	74	+ //
	75	+ // Ordering: every ownership test in there reads state the database
	76	+ // cleanup below is about to destroy — sitemap filenames come from the
	77	+ // settings table, the IndexNow key file's name from an option. Run it
	78	+ // after, and there is nothing left to identify our files by.
	79	+ //
	80	+ // Not gated on $keep_data because these are not the user's data. They
	81	+ // are artifacts of a plugin that is being removed, and leaving them is
	82	+ // actively harmful: a real file at /sitemap_index.xml is served by the
	83	+ // web server before WordPress boots, so it goes on shadowing RankMath,
	84	+ // Squirrly or core's own sitemap indefinitely — while rendering blank,
	85	+ // since the XSL stylesheet it points at leaves with the plugin (#510).
	86	+ // "Keep my data" means keep the settings for a reinstall, not keep a
	87	+ // dead file breaking the next plugin. On reinstall they are republished
	88	+ // from the settings that were kept.
	89	+ self::remove_webroot_files();
	90	+
36	91	if (!$keep_data) {
37	92	self::remove_database_tables();
38	93	self::remove_options();
39	94	self::remove_user_meta();
40	95	self::remove_post_meta();
	96	+ self::remove_term_meta();
41	97	}
42	98
43	99	self::clear_caches();
44	100	self::remove_cron_jobs();
45	101	self::remove_capabilities();
	102	+ self::mark_uninstalled();
46	103	}
47		-
	104	+
48	105	/**
	106	+ * Delete every file ThinkRank published into the WordPress web root.
	107	+ *
	108	+ * The sitemap, robots.txt, llms.txt and the IndexNow key file are real files
	109	+ * in `ABSPATH`, not routes, so removing the plugin has to remove them too —
	110	+ * otherwise the web server keeps serving a sitemap belonging to a plugin
	111	+ * that is no longer installed, and the next SEO plugin's own sitemap can
	112	+ * never answer (#510).
	113	+ *
	114	+ * @since 2.1.0
	115	+ *
	116	+ * @return void
	117	+ */
	118	+ private static function remove_webroot_files(): void {
	119	+ // No autoloader here — WP_UNINSTALL_PLUGIN loads this file without the
	120	+ // plugin — so the removal logic comes from the same plain function file
	121	+ // the deactivator and the sitemap generator use. One copy, not three.
	122	+ $shared = __DIR__ . '/includes/cleanup-webroot.php';
	123	+
	124	+ if (!is_readable($shared)) {
	125	+ return;
	126	+ }
	127	+
	128	+ require_once $shared;
	129	+
	130	+ if (function_exists('thinkrank_webroot_cleanup')) {
	131	+ thinkrank_webroot_cleanup();
	132	+ }
	133	+ }
	134	+
	135	+ /**
	136	+ * The shared cleanup manifest.
	137	+ *
	138	+ * There is no autoloader here — WP_UNINSTALL_PLUGIN loads this file without
	139	+ * the plugin — so the cron-hook and capability lists come from a plain
	140	+ * array file that the deactivator reads too.
	141	+ *
	142	+ * @return array{cron_hooks: string[], capabilities: string[]}
	143	+ */
	144	+ private static function manifest(): array {
	145	+ return require __DIR__ . '/includes/cleanup-manifest.php';
	146	+ }
	147	+
	148	+ /**
	149	+ * Record that the user deliberately uninstalled the plugin.
	150	+ *
	151	+ * ThinkRank Pro auto-installs and activates the free plugin whenever it
	152	+ * finds it missing, which silently re-ran the activator and recreated every
	153	+ * table this uninstall had just dropped. Pro reads this marker and stops
	154	+ * auto-installing, falling back to its "Install ThinkRank" notice, so a
	155	+ * deliberate removal stays removed until the user asks for it back.
	156	+ *
	157	+ * Written last, after remove_options() has wiped the `thinkrank_` namespace,
	158	+ * and cleared again by Activator on the next activation.
	159	+ *
	160	+ * @return void
	161	+ */
	162	+ private static function mark_uninstalled(): void {
	163	+ delete_option(self::UNINSTALLED_OPTION);
	164	+ add_option(self::UNINSTALLED_OPTION, time(), '', 'no');
	165	+ }
	166	+
	167	+ /**
49	168	* Remove custom database tables
50	169	*
51	170	* @return void
52	171	*/
		@@ -68,16 +187,21 @@
68	187	$wpdb->prefix . 'thinkrank_seo_schema',
69	188	$wpdb->prefix . 'thinkrank_seo_social',
70	189	$wpdb->prefix . 'thinkrank_seo_local',
71	190	$wpdb->prefix . 'thinkrank_email_report_logs',
72		- // Rank Tracker Tables
73		- $wpdb->prefix . 'thinkrank_rank_tracking',
74		- $wpdb->prefix . 'thinkrank_tracked_keywords',
75		- // Pro feature tables (redirections, broken links, local SEO)
76		- $wpdb->prefix . 'thinkrank_redirects',
77		- $wpdb->prefix . 'thinkrank_404_logs',
78		- $wpdb->prefix . 'thinkrank_broken_links',
79		- $wpdb->prefix . 'thinkrank_locations',
	191	+ // AI Visibility Tables. These were registered in Database_Schema but
	192	+ // never listed here, so an uninstall left them behind — bv_tasks in
	193	+ // particular holds the full text of every AI answer (#302). The
	194	+ // three Brand Visibility tables are no longer created, but sites
	195	+ // that used the feature before it was removed still have them.
	196	+ $wpdb->prefix . 'thinkrank_ai_traffic',
	197	+ $wpdb->prefix . 'thinkrank_brand_visibility_checks',
	198	+ $wpdb->prefix . 'thinkrank_bv_runs',
	199	+ $wpdb->prefix . 'thinkrank_bv_tasks',
	200	+ // Rank Tracker, Redirections, Broken Links and Local SEO tables are
	201	+ // created and dropped by ThinkRank Pro's own uninstaller. Free used to
	202	+ // drop them here, which destroyed a still-active Pro install's data
	203	+ // when only the free plugin was removed (#384).
80	204	];
81	205
82	206	foreach ($tables as $table) {
83	207	// Check WordPress version for %i support (introduced in 6.2)
		@@ -100,17 +224,23 @@
100	224	*
101	225	* @return void
102	226	*/
103	227	private static function remove_options(): void {
104		- // Remove all ThinkRank options using wildcard delete for completeness
	228	+ // Remove all ThinkRank options using wildcard delete for completeness.
	229	+ //
	230	+ // `thinkrank_%` also matches `thinkrank_pro_%`, so this used to delete a
	231	+ // still-active Pro install's license key and every module setting (#384).
	232	+ // Pro ships its own uninstaller and owns that namespace exclusively, so
	233	+ // every pattern here excludes it.
105	234	global $wpdb;
106	235	// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Uninstall cleanup requires direct database access to remove all plugin options
107	236	$wpdb->query(
108	237	$wpdb->prepare(
109	238	"DELETE FROM {$wpdb->options}
110		- WHERE option_name LIKE %s
	239	+ WHERE (option_name LIKE %s AND option_name NOT LIKE %s)
111	240	OR option_name LIKE %s",
112	241	$wpdb->esc_like('thinkrank_') . '%',
	242	+ $wpdb->esc_like('thinkrank_pro_') . '%',
113	243	// Appsero / WP Insights telemetry options (wpins_thinkrank_*)
114	244	$wpdb->esc_like('wpins_thinkrank_') . '%'
115	245	)
116	246	);
		@@ -120,12 +250,14 @@
120	250	// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Core table name is safe, uninstall cleanup requires direct database access
121	251	$wpdb->query(
122	252	$wpdb->prepare(
123	253	"DELETE FROM {$wpdb->options}
124		- WHERE option_name LIKE %s
125		- OR option_name LIKE %s",
	254	+ WHERE (option_name LIKE %s AND option_name NOT LIKE %s)
	255	+ OR (option_name LIKE %s AND option_name NOT LIKE %s)",
126	256	$wpdb->esc_like('_transient_thinkrank_') . '%',
127		- $wpdb->esc_like('_transient_timeout_thinkrank_') . '%'
	257	+ $wpdb->esc_like('_transient_thinkrank_pro_') . '%',
	258	+ $wpdb->esc_like('_transient_timeout_thinkrank_') . '%',
	259	+ $wpdb->esc_like('_transient_timeout_thinkrank_pro_') . '%'
128	260	)
129	261	);
130	262	// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
131	263	}
		@@ -173,8 +305,35 @@
173	305	}
174	306
175	307
176	308	/**
	309	+ * Remove term meta data
	310	+ *
	311	+ * The plugin writes term meta from the term UI, the abilities API
	312	+ * (Update_Term_Seo) and the importer (Snapshot_Migrator) — SEO title,
	313	+ * meta description, the robots payload and the `_thinkrank_imported_from`
	314	+ * marker — and there was no counterpart to remove_post_meta(), so all of
	315	+ * it outlived the plugin (#399).
	316	+ *
	317	+ * @return void
	318	+ */
	319	+ private static function remove_term_meta(): void {
	320	+ global $wpdb;
	321	+
	322	+ // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Core table name is safe, uninstall cleanup requires direct database access
	323	+ $wpdb->query(
	324	+ $wpdb->prepare(
	325	+ "DELETE FROM {$wpdb->termmeta}
	326	+ WHERE meta_key LIKE %s
	327	+ OR meta_key LIKE %s",
	328	+ $wpdb->esc_like('thinkrank_') . '%',
	329	+ $wpdb->esc_like('_thinkrank_') . '%'
	330	+ )
	331	+ );
	332	+ // phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
	333	+ }
	334	+
	335	+ /**
177	336	* Clear all caches
178	337	*
179	338	* @return void
180	339	*/
		@@ -190,14 +349,12 @@
190	349	*
191	350	* @return void
192	351	*/
193	352	private static function remove_cron_jobs(): void {
194		- $cron_jobs = [
195		- 'thinkrank_cache_cleanup',
196		- 'thinkrank_usage_analytics',
197		- ];
198		-
199		- foreach ($cron_jobs as $job) {
	353	+ // Was 2 hooks against the 15 the plugin schedules, and weaker than the
	354	+ // deactivator's 5 — so uninstalling without deactivating first left
	355	+ // even more behind (#389).
	356	+ foreach (self::manifest()['cron_hooks'] as $job) {
200	357	wp_clear_scheduled_hook($job);
201	358	}
202	359	}
203	360
		@@ -212,35 +369,16 @@
212	369	// short-circuit on the next install and never re-grant thinkrank_access,
213	370	// locking administrators out of the admin menu.
214	371	delete_option('thinkrank_caps_version');
215	372
216		- // Keep in sync with ThinkRank\Core\Capability_Manager::capabilities().
217		- // The plugin autoloader isn't available during uninstall, so the slugs are
218		- // mirrored here. The trailing legacy slugs were granted by older versions
219		- // and are removed too so historical roles are fully cleaned.
220		- $capabilities = [
221		- 'thinkrank_access',
222		- 'thinkrank_site_identity',
223		- 'thinkrank_analytics',
224		- 'thinkrank_performance',
225		- 'thinkrank_global_seo',
226		- 'thinkrank_image_seo',
227		- 'thinkrank_schema',
228		- 'thinkrank_social_media',
229		- 'thinkrank_crawling',
230		- 'thinkrank_instant_indexing',
231		- 'thinkrank_author_archives',
232		- 'thinkrank_content_tools',
233		- 'thinkrank_internal_links',
234		- 'thinkrank_settings',
235		- 'thinkrank_manage_roles',
236		- // Legacy slugs (pre-Role Manager) — remove if still present.
237		- 'thinkrank_manage_settings',
238		- 'thinkrank_view_analytics',
239		- 'thinkrank_manage_credits',
240		- 'thinkrank_use_ai_features',
241		- ];
242		-
	373	+ // From the shared manifest. The hand-mirrored copy that used to live
	374	+ // here had drifted from Capability_Manager::capabilities() by four
	375	+ // slugs — thinkrank_ai_insights, thinkrank_redirections,
	376	+ // thinkrank_broken_links and thinkrank_woocommerce were still granted
	377	+ // to every role after an uninstall (#399). The manifest also carries
	378	+ // the pre-Role-Manager slugs so historical roles are fully cleaned.
	379	+ $capabilities = self::manifest()['capabilities'];
	380	+
243	381	$roles = wp_roles();
244	382
245	383	foreach ($roles->roles as $role_name => $role_info) {
246	384	$role = get_role($role_name);