1 system.api.php hook_uninstall()

Remove any information that the module sets.

The information that the module should remove includes:

  • settings that the module has set using state_set().
  • modifications to existing tables

The module should not remove its entry from the {system} table. Database tables defined by hook_schema() will be removed automatically.

The uninstall hook must be implemented in the module's .install file. It will fire when the module gets uninstalled but before the module's database tables are removed, allowing your module to query its own tables during this routine.

When hook_uninstall() is called, your module will already be disabled, so its .module file will not be automatically included. If you need to call API functions from your .module file in this hook, use backdrop_load() to make them available. (Keep this usage to a minimum, though, especially when calling API functions that invoke hooks, or API functions from modules listed as dependencies, since these may not be available or work as expected when the module is disabled.)

See also

hook_install()

hook_schema()

hook_disable()

hook_modules_uninstalled()

Related topics

Hooks Allow modules to interact with the Backdrop core.

File

core/modules/system/system.api.php, line 3184
Hooks provided by Backdrop core and the System module.

Code

function hook_uninstall() {
  state_del('my_module_last_cron');
}