function hook_install

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Extension/module.api.php \hook_install()
  2. 8.9.x core/lib/Drupal/Core/Extension/module.api.php \hook_install()
  3. 10 core/lib/Drupal/Core/Extension/module.api.php \hook_install()
  4. 11.x core/lib/Drupal/Core/Extension/module.api.php \hook_install()

Perform setup tasks when the module is installed.

If the module implements hook_schema(), the database tables will be created before this hook is fired.

Implementations of this hook are by convention declared in the module's .install file. The implementation can rely on the .module file being loaded. The hook will only be called the first time a module is enabled or after it is re-enabled after being uninstalled. The module's schema version will be set to the module's greatest numbered update hook. Because of this, any time a hook_update_N() is added to the module, this function needs to be updated to reflect the current version of the database schema.

See the Schema API documentation for details on hook_schema and how database tables are defined.

Note that since this function is called from a full bootstrap, all functions (including those in modules enabled by the current page request) are available when this hook is called. Use cases could be displaying a user message, or calling a module function necessary for initial setup, etc.

Please be sure that anything added or modified in this function that can be removed during uninstall should be removed with hook_uninstall().

See also







Related topics

27 functions implement hook_install()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

actions_loop_test_install in modules/simpletest/tests/actions_loop_test.install
Implements hook_install().
block_install in modules/block/block.install
Implements hook_install().
blog_install in modules/blog/blog.install
Implements hook_install().
book_install in modules/book/book.install
Implements hook_install().
contact_install in modules/contact/contact.install
Implements hook_install().

... See full list

2 invocations of hook_install()
drupal_install_system in includes/
Installs the system module.
module_enable in includes/
Enables or installs a given list of modules.


modules/system/system.api.php, line 3400


function hook_install() {
    // Populate the default {node_access} record.
        'nid' => 0,
        'gid' => 0,
        'realm' => 'all',
        'grant_view' => 1,
        'grant_update' => 0,
        'grant_delete' => 0,

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.