Fix: Uninstall distributor

[dinhtungdu]

Description of the Change

• Add uninstall.php script to delete distributor data in the database.
• Add DT_REMOVE_ALL_DATA constant to prevent accidental data deletion.

A modal will display when deactivating the plugin. This modal does not display in sub-sites.

Benefits

Delete distributor data on uninstalling.

Possible Drawbacks

n/a

Verification Process

Check the database manually.

Checklist:

• I have read the CONTRIBUTING document.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my change.
• All new and existing tests passed.

Applicable Issues

Closes #349

Changelog Entry

[jeffpaul]

Moving this to 2.1.0 as we still need to discuss what items we can/should safely remove during uninstall.

[ravinderk]

@peterwilsoncc, Can you provide a list of data we should remove when someone installs a plugin?

cc: @dkotter @jeffpaul

[ravinderk]

@peterwilsoncc Distributor supports multisite. In this case, the Super Admin can only delete the plugin. I think we should clear distributor plugin data from subsites, what does this think?

cc: @jeffpaul

[jeffpaul]

@ravinderk so you're asking about the case where distributor is network installed and network activated (different from the case where it's installed or activated on individual sites for a use case where someone only wants distributor to work on parts of a multi site)?

[ravinderk]

@ravinderk so you're asking about the case where distributor is network installed and network activated (different from the case where it's installed or activated on individual sites for a use case where someone only wants distributor to work on parts of a multi site)?

@jeffpaul You are correct.

[jeffpaul]

I'm not quite wildly in favor of deleting Distributor syndication mapping post meta when someone deactivates the plugin, though I suppose if someone actually uninstalls (again, specifically considering this differently from deactivating) it's probably fine to clear Distributor data. The downside is someone who then wants to re-install and activate Distributor that all previous syndication mappings would be gone and make things super difficult to get synchronized again, but that would fall into a _doing_it_wrong() scenario.

@ravinderk want to work on iterating on the PR here to properly remove Distributor data when someone uninstalls the plugin (again, NOT when its merely deactivated but ONLY when it's uninstalled)?

[ravinderk]

I'm not quite wildly in favor of deleting Distributor syndication mapping post meta when someone deactivates the plugin, though I suppose if someone actually uninstalls (again, specifically considering this differently from deactivating), it's probably fine to clear Distributor data. The downside is that for someone who then wants to re-install and activate Distributor, all previous syndication mappings would be gone and make things super difficult to get synchronized again, but that would fall into a _doing_it_wrong() scenario.

@ravinderk wants to work on iterating on the PR here to properly remove Distributor data when someone uninstalls the plugin (again, NOT when it's merely deactivated but ONLY when it's uninstalled)?

@jeffpaul I implemented logic to remove distributor data from the database only if:

• Admin uninstalling plugin
• DT_REMOVE_ALL_DATA is set to true (to prevent accidental deletion of data)

I also recommend showing the modal when uninstalling the distributor plugin to inform the admin.

@ravinderk, so you're asking about the case where the distributor is network installed and network activated (different from the case where it's installed or activated on individual sites for a use case where someone only wants the distributor to work on parts of a multi-site)?

Removing distributor data from each subsite can be very resource-intensive. I think we should not do it and inform the admin about this when uninstalling the plugin

[jeffpaul]

I also recommend showing the modal when uninstalling the distributor plugin to inform the admin.

Removing distributor data from each subsite can be very resource-intensive. I think we should not do it and inform the admin about this when uninstalling the plugin.

I concur on both points.

[ravinderk]

@jeffpaul I implemented the deactivation modal.

cc: @peterwilsoncc

[peterwilsoncc]

I've added a few notes inline

[peterwilsoncc]

This will only remove the data from the current site (the network base site on the network tab) but the data will remain on sub-sites.

It might be possible to loop through the sites on small networks.

[ravinderk]

@peterwilsoncc, after discussing with @jeffpaul, we decided to take care of the main website. It will be helpful for users to be aware of this.

@jeffpaul Do you have thoughts?

[jeffpaul]

I think that so long as we've presented the admin uninstalling Distributor with an "are you sure" sort of message on the impacts of fully removing Distributor data, then we should look for a reliable and performant, if slow and long-running, approach to clearing that data across all sites on a network.

[jeffpaul]

Let's follow what WP.org recommends/requires: https://developer.wordpress.org/plugins/plugin-basics/uninstall-methods/

[jeffpaul]

@10up/open-source-practice another PR that would be good to look into getting wrapped up and ready for release