register_uninstall_hook( string $file, callable $callback )

Set the uninstallation hook for a plugin.


Description Description

Registers the uninstall hook that will be called when the user clicks on the uninstall link that calls for the plugin to uninstall itself. The link won’t be active unless the plugin hooks into the action.

The plugin should not run arbitrary code outside of functions, when registering the uninstall hook. In order to run using the hook, the plugin will have to be included, which means that any code laying outside of a function will be run during the uninstall process. The plugin should not hinder the uninstall process.

If the plugin can not be written without running code within the plugin, then the plugin should create a file named ‘uninstall.php’ in the base plugin folder. This file will be called, if it exists, during the uninstall process bypassing the uninstall hook. The plugin, when using the ‘uninstall.php’ should always check for the ‘WP_UNINSTALL_PLUGIN’ constant, before executing.


Parameters Parameters

$file

(string) (Required) Plugin file.

$callback

(callable) (Required) The callback to run when the hook is called. Must be a static method or function.


Top ↑

Source Source

File: wp-includes/plugin.php

function register_uninstall_hook( $file, $callback ) {
	if ( is_array( $callback ) && is_object( $callback[0] ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'Only a static class method or function can be used in an uninstall hook.' ), '3.1' );
		return;
	}

	/*
	 * The option should not be autoloaded, because it is not needed in most
	 * cases. Emphasis should be put on using the 'uninstall.php' way of
	 * uninstalling the plugin.
	 */
	$uninstallable_plugins = (array) get_option('uninstall_plugins');
	$uninstallable_plugins[plugin_basename($file)] = $callback;

	update_option('uninstall_plugins', $uninstallable_plugins);
}


Top ↑

Changelog Changelog

Changelog
Version Description
2.7.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note content
    Contributed by sangeethksin

    Perform Uninstall hook inside register_activation_hook

    function your_prefix_activate(){
    	register_uninstall_hook( __FILE__, 'your_prefix_uninstall' );
    }
    register_activation_hook( __FILE__, 'your_prefix_activate' );
    
    // And here goes the uninstallation function:
    function your_prefix_uninstall(){
    	//	codes to perform during unistallation
    }
    

You must log in before being able to contribute a note.