hook_install

• Drupal 4.7
• Drupal 5
• Drupal 6
• Drupal 7

• View documentation
• List references

Definition

hook_install()
developer/hooks/install.php, line 167

Description

Install the current version of the database schema, and any other setup tasks.

The hook will be called the first time a module is installed, and the module's schema version will be set to the module's greatest numbered update hook. Because of this, anytime 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 at http://drupal.org/node/146843 for details on hook_schema, where a 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.

Related topics

Name	Description
Hooks	Allow modules to interact with the Drupal core.

Code

<?php
function hook_install() {
  drupal_install_schema('upload');
}
?>