register_deactivation_hook() WordPress Function
The register_deactivation_hook() function is used to register a plugin's deactivation hook. This function takes two parameters: the name of the plugin file and the name of the function to be called when the plugin is deactivated.
register_deactivation_hook( string $file, callable $callback ) #
Sets the deactivation hook for a plugin.
Description
When a plugin is deactivated, the action ‘deactivate_PLUGINNAME’ hook is called. In the name of this hook, PLUGINNAME is replaced with the name of the plugin, including the optional subdirectory. For example, when the plugin is located in wp-content/plugins/sampleplugin/sample.php, then the name of this hook will become ‘deactivate_sampleplugin/sample.php’.
When the plugin consists of only one file and is (as by default) located at wp-content/plugins/sample.php the name of this hook will be ‘deactivate_sample.php’.
Parameters
- $file
(string)(Required)The filename of the plugin including the path.
- $callback
(callable)(Required)The function hooked to the 'deactivate_PLUGIN' action.
Source
File: wp-includes/plugin.php
function register_deactivation_hook( $file, $callback ) {
$file = plugin_basename( $file );
add_action( 'deactivate_' . $file, $callback );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |