wpseek.com
A WordPress-centric search engine for devs and theme authors



register_deactivation_hook › WordPress Function

Since2.0.0
Deprecatedn/a
› register_deactivation_hook ( $file, $callback )
Parameters: (2)
  • (string) $file The filename of the plugin including the path.
    Required: Yes
  • (callable) $callback The function hooked to the 'deactivate_PLUGIN' action.
    Required: Yes
Defined at:
Codex:

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


Related Functions: register_activation_hook, register_taxonomy, register_setting, unregister_meta_key, unregister_taxonomy

Source 

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