Same name and namespace in other branches
- 7.x modules/system/system.api.php \hook_schema_alter()
Performs alterations to existing database schemas.
When a module modifies the database structure of another module (by changing, adding or removing fields, keys or indexes), it should implement hook_schema_alter() to update the default $schema to take its changes into account.
See hook_schema() for details on the schema definition structure.
Parameters
$schema: Nested array describing the schemas for all modules.
Return value
None.
Related topics
File
- developer/
hooks/ core.php, line 725 - These are the hooks that are invoked by the Drupal core.
Code
function hook_schema_alter(&$schema) {
// Add field to existing schema.
$schema['users']['fields']['timezone_id'] = array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Per-user timezone configuration.',
);
}