Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use pre_uninstall_plugin action in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
July 12, 2022
5 minutes read

pre_uninstall_plugin action

Fires in uninstall_plugin() immediately before the plugin is uninstalled.

To use pre_uninstall_plugin action, first you have to register it using add_action. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at Flipper Code, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function execute_on_pre_uninstall_plugin_event which takes 2 parameters and we registered using add_action. The first parameter pre_uninstall_plugin is name of the hook, The second parameter execute_on_pre_uninstall_plugin_event is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_action to remove pre_uninstall_plugin action.

Parameters

    Below are the 2 parameters are required to use this hook.

  • $plugin : (string) Path to the plugin file relative to the plugins directory.
  • $uninstallable_plugins : (array) Uninstallable plugins.

Live Example

do_action( 'pre_uninstall_plugin', string $plugin, array $uninstallable_plugins )

Below is an example how you can use this hook.

                        function execute_on_pre_uninstall_plugin_event($plugin, $uninstallable_plugins){
                           //You can write code here to be executed when this action occurs in WordPress. Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
                           
                        }
                        // add the action
                        add_action( "pre_uninstall_plugin", "execute_on_pre_uninstall_plugin_event" , 10, 2);

To remove a hook callback, use the example below.

remove_action( "pre_uninstall_plugin", "execute_on_pre_uninstall_plugin_event", 10, 2 );

Please make sure provide the same callback function name, priority and number of arguments while removing the hook callback.

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.