Directory

Plugin cannot be uninstalled if uninstall times out/crashes by kkmuffme · Pull Request #6018 · WordPress/wordpress-develop · GitHub

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Plugin cannot be uninstalled if uninstall times out/crashes #6018

Open

kkmuffme wants to merge 2 commits into WordPress:trunk from kkmuffme:plugin-cannot-be-uninstalled-if-uninstall-timed-out

+89 −30

kkmuffme commented Feb 2, 2024 •

edited

Plugin cannot be uninstalled if uninstall times out/crashes and hook is registered conditionally.
This PR will remove the plugin from uninstallable plugins only after the uninstall hook ran to fix this bug.

Trac ticket: https://core.trac.wordpress.org/ticket/59402
Trac ticket: https://core.trac.wordpress.org/ticket/43098
Trac ticket: https://core.trac.wordpress.org/ticket/26735


          Plugin cannot be uninstalled if uninstall times out/crashes and hook …

a846d4b

…is registered conditionally

Fix https://core.trac.wordpress.org/ticket/59402

github-actions bot commented Feb 2, 2024 •

edited

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props kkmuffme, swissspidy.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

github-actions bot commented Feb 2, 2024

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

swissspidy reviewed

View reviewed changes

Member

swissspidy left a comment

I don't think we need a new variable here, see suggestions.

If we're worried about plugins interfering with the global variable, we should consider a name a la $_wp_uninstallable_plugins if anything. But again probably not needed.

src/wp-admin/includes/plugin.php Outdated Show resolved Hide resolved

src/wp-admin/includes/plugin.php Outdated Show resolved Hide resolved


          rework uninstall to make it more consistent

ef0c6dc

* call uninstall_ hook if there is no uninstall callable or no uninstall.php
* ensure that callable is valid before calling to avoid fatals
* add after_uninstall_plugin hook
* fix PHP notice from already defined constant

Rajinsharwar reviewed

View reviewed changes

src/wp-admin/includes/plugin.php

Comment on lines +1250 to +1254

+              		if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
+              			// The constant value does not indicate the plugin being uninstalled
+              			// e.g. in bulk actions it is the first plugin uninstalled.
+              			// The value should not be used and is only available for legacy reasons.
+              			define( 'WP_UNINSTALL_PLUGIN', $plugin_basename );

Rajinsharwar Apr 22, 2024

Suggested change

      
            		if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
          
            			// The constant value does not indicate the plugin being uninstalled
          
            			// e.g. in bulk actions it is the first plugin uninstalled.
          
            			// The value should not be used and is only available for legacy reasons.
          
            			define( 'WP_UNINSTALL_PLUGIN', $plugin_basename );
          
            		/**
          
            		 * The constant value does not indicate the plugin being uninstalled.
          
            		 *
          
            		 * e.g. in bulk actions it is the first plugin uninstalled.
          
            		 * 
          
            		 * The value should not be used and is only available for legacy reasons.
          
            		*/
          
            		if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
          
            			define( 'WP_UNINSTALL_PLUGIN', $plugin_basename );

Author

kkmuffme May 15, 2024

Thanks, should there really be a blank line between each of them though?

src/wp-admin/includes/plugin.php

+              		unset( $uninstallable_plugins[ $plugin_basename ] );
+              	}
+              	$uninstall_file = WP_PLUGIN_DIR . '/' . dirname( $plugin_basename ) . '/uninstall.php';

Rajinsharwar Apr 22, 2024

Better to have a file_exists check over here.

Author

kkmuffme May 15, 2024

Why?

src/wp-admin/includes/plugin.php

-              		if ( isset( $uninstallable_plugins[ $file ] ) ) {
-              			unset( $uninstallable_plugins[ $file ] );
-              			update_option( 'uninstall_plugins', $uninstallable_plugins );
+              	// must be a separate variable in case we have a null or false callable value

Rajinsharwar Apr 22, 2024

Suggested change

      
            	// must be a separate variable in case we have a null or false callable value
          
            	// Must be a separate variable in case we have a null or false callable value.

Author

kkmuffme May 15, 2024

Thanks! Will fix to uppercase things all at once when all other review points are discussed/finalized

src/wp-admin/includes/plugin.php

+              	} else {
+              		$uninstall_file = WP_PLUGIN_DIR . '/' . $plugin_basename;
+              		if ( ! is_readable( $uninstall_file ) ) {
+              			// the plugin was previous uninstalled already but the option not updated due to a race condition

Rajinsharwar Apr 22, 2024

Suggested change

      
            			// the plugin was previous uninstalled already but the option not updated due to a race condition
          
            			// The plugin was previously uninstalled already but the option was not updated due to a race condition.

src/wp-admin/includes/plugin.php Show resolved Hide resolved

src/wp-admin/includes/plugin.php

+              	 * Fires in uninstall_plugin() once the plugin has been uninstalled.
+              	 *
+              	 * The action concatenates the 'uninstall_' prefix with the basename of the
+              	 * plugin passed to uninstall_plugin() to create a dynamically-named action.

Rajinsharwar Apr 22, 2024

Suggested change

      
            	 * plugin passed to uninstall_plugin() to create a dynamically-named action.
          
            	 * Plugin passed to uninstall_plugin() to create a dynamically-named action.

src/wp-includes/plugin.php

-              	$file = trim( $file, '/' );
-              	return $file;
+              	$file = preg_replace( '#^(?>' . preg_quote( $plugin_dir, '#' ) . '|' . preg_quote( $mu_plugin_dir, '#' ) . ')/#', '', $file, 1 );
+              	return trim( $file, '/' );

Rajinsharwar Apr 22, 2024

Suggested change

      
            	return trim( $file, '/' );
          
            	$file = trim( $file, '/' );
          
            	return $file;

Let's not change this if it's not necessary.

Author

kkmuffme May 15, 2024

Why keep a bad practice?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment