WordPress at a glance

register_deactivation_hook() WP 1.0

Set the deactivation hook for a plugin.

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'.

No Hooks.

Return

Nothing (null).

Usage

register_deactivation_hook( $file, $function );
$file(string) (required)
The filename of the plugin including the path.
$function(callable) (required)
The function hooked to the 'deactivate_PLUGIN' action.

Code of register_deactivation_hook: wp-includes/plugin.php VER 5.0.1

<?php
function register_deactivation_hook($file, $function) {
	$file = plugin_basename($file);
	add_action('deactivate_' . $file, $function);
}

Related Functions

From category: Plugins, Hooks

No comments
    Hello, !     Log In . Register