function _drupal_schema_initialize

Same name in other branches
  1. 7.x includes/common.inc \_drupal_schema_initialize()
  2. 9 core/includes/schema.inc \_drupal_schema_initialize()

Fills in required default values for table definitions from hook_schema().

Parameters

array $schema: The schema definition array as it was returned by the module's hook_schema().

string $module: The module for which hook_schema() was invoked.

bool $remove_descriptions: (optional) Whether to additionally remove 'description' keys of all tables and fields to improve performance of serialize() and unserialize(). Defaults to TRUE.

Related topics

2 calls to _drupal_schema_initialize()
drupal_install_schema in core/includes/schema.inc
Creates all tables defined in a module's hook_schema().
drupal_uninstall_schema in core/includes/schema.inc
Removes all tables defined in a module's hook_schema().

File

core/includes/schema.inc, line 188

Code

function _drupal_schema_initialize(&$schema, $module, $remove_descriptions = TRUE) {
    // Set the name and module key for all tables.
    foreach ($schema as $name => &$table) {
        if (empty($table['module'])) {
            $table['module'] = $module;
        }
        if (!isset($table['name'])) {
            $table['name'] = $name;
        }
        if ($remove_descriptions) {
            unset($table['description']);
            foreach ($table['fields'] as &$field) {
                unset($field['description']);
            }
        }
    }
}

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