Blocks are the boxes visible in the sidebar(s) of your web site. These are usually generated automatically by modules (e.g. recent forum topics), but you can also create your own blocks.
-The sidebar each block appears in depends on both which theme you are using (some are left-only, some right, some both), and on the settings in block management.
+The region each block appears in depends on both which theme you are using (some are left-only, some right, some both, and some may offer other regions), and on the settings in block management.
The block management screen lets you specify the vertical sort-order of the blocks within a sidebar. You do this by assigning a weight to each block. Lighter blocks (smaller weight) "float up" towards the top of the sidebar. Heavier ones "sink down" towards the bottom of it.
A block\'s visibility depends on:
Blocks are the boxes in the left and right side bars of the web site. They are made available by modules or created manually.
-Only enabled blocks are shown. You can position the blocks by deciding which side of the page they will show up on (sidebar) and in which order they appear (weight).
+Blocks are content rendered into regions, often boxes in the left and right side bars of the web site. They are made available by modules or created manually.
+Only enabled blocks are shown. You can position the blocks by deciding which area of the page they will show up on (e.g., a sidebar) and in which order they appear (weight). Highlighting on this page shows the regions where content will be rendered.
If you want certain blocks to disable themselves temporarily during high server loads, check the 'Throttle' box. You can configure the auto-throttle on the throttle configuration page after having enabled the throttle module.
", array('%throttle' => url('admin/settings/throttle'))); case 'admin/block/add': @@ -112,7 +112,7 @@ function block_admin_save($edit) { foreach ($edit as $module => $blocks) { foreach ($blocks as $delta => $block) { - db_query("UPDATE {blocks} SET region = %d, status = %d, weight = %d, throttle = %d WHERE module = '%s' AND delta = '%s'", + db_query("UPDATE {blocks} SET region = '%s', status = %d, weight = %d, throttle = %d WHERE module = '%s' AND delta = '%s'", $block['region'], $block['status'], $block['weight'], $block['throttle'], $module, $delta); } } @@ -142,6 +142,7 @@ foreach ($module_blocks as $delta => $block) { $block['module'] = $module; $block['delta'] = $delta; + // If previously written to database, load values. if ($old_blocks[$module][$delta]) { $block['status'] = $old_blocks[$module][$delta]->status; $block['weight'] = $old_blocks[$module][$delta]->weight; @@ -151,15 +152,20 @@ $block['custom'] = $old_blocks[$module][$delta]->custom; $block['throttle'] = $old_blocks[$module][$delta]->throttle; } + // Otherwise, use any set values, or else substitute defaults. else { - $block['status'] = $block['weight'] = $block['region'] = $block['custom'] = 0; - $block['pages'] = ''; + $properties = array ('status' => 0, 'weight' => 0, 'region' => 'left', 'pages' => '', 'custom' => 0); + foreach ($properties as $property => $default) { + if (!isset ($block[$property])) { + $block[$property] = $default; + } + } } // reinsert blocks into table - db_query("INSERT INTO {blocks} (module, delta, status, weight, region, visibility, pages, custom, throttle) VALUES ('%s', '%s', %d, %d, %d, %d, '%s', %d, %d)", - $block['module'], $block['delta'], $block['status'], $block['weight'], $block['region'], $block['visibility'], $block['pages'], $block['custom'], $block['throttle']); + db_query("INSERT INTO {blocks} (module, delta, status, weight, region, visibility, pages, custom, throttle) VALUES ('%s', '%s', %d, %d, '%s', %d, '%s', %d, %d)", + $block['module'], $block['delta'], $block['status'], $block['weight'], $block['region'], $block['visibility'], $block['pages'], $block['custom'], $block['throttle']); $blocks[] = $block; // build array to sort on @@ -180,15 +186,22 @@ function block_admin_display() { $blocks = _block_rehash(); - $header = array(t('Block'), t('Enabled'), t('Weight'), t('Sidebar')); + // Highlight regions on page, to provide visual reference. + block_set_region_css(); + foreach (system_region_list() as $key => $value) { + drupal_set_content($key, '' . t('* This region is not available in the default theme, so any blocks assigned to it will be assigned to the default region, %region.', array('%region' => $block_regions[system_default_region()])) . '
'; + } + if ($module_region_message) { + $output .= '' . t('** This region is defined by a module, and so may not be available in all contexts.') . '
'; + } + $output .= form_submit(t('Save blocks')); return form($output, 'post', url('admin/block')); } +/** + * Set the css for display of block region marking. + */ +function block_set_region_css() { + drupal_set_html_head(' + + '); +} + function block_box_get($bid) { return db_fetch_array(db_query('SELECT * FROM {boxes} WHERE bid = %d', $bid)); } @@ -341,7 +389,6 @@ $output .= filter_form('format', $edit['format']); $output .= form_textarea(t('Block body'), 'body', $edit['body'], 60, 15, t('The content of the block as shown to the user.')); $output .= form_textfield(t('Block description'), 'info', $edit['info'], 60, 64, t('A brief description of your block. Used on the block overview page.', array('%overview' => url('admin/block')))); - return $output; } @@ -358,7 +405,7 @@ form_set_error('title', t('Please ensure each block description is unique.')); return false; } - db_query("INSERT INTO {boxes} (title, body, info, format) VALUES ('%s', '%s', '%s', %d)", $edit['title'], $edit['body'], $edit['info'], $edit['format']); + db_query("INSERT INTO {boxes} (title, body, info, format) VALUES ('%s', '%s', '%s', %d, %d)", $edit['title'], $edit['body'], $edit['info'], $edit['format']); } return true; } @@ -412,39 +459,36 @@ } } - /** - * Return all blocks in the specied region for the current user. You may - * use this function to implement variable block regions. The default - * regions are 'left', 'right' and 'all', where 'all' means both left and - * right. - * - * @param $region - * This is a string which describes in a human readable form which region - * you need. - * - * @param $regions - * This is an optional array and contains map(s) from the string $region to - * the numerical region value(s) in the blocks table. See default value for - * examples. - * - * @return - * An array of block objects, indexed with module_delta. - * If you are displaying your blocks in one or two sidebars, you may check - * whether this array is empty to see how many columns are going to be - * displayed. - * - * @todo - * Add a proper primary key (bid) to the blocks table so we don't have - * to mess around with this module_delta construct. - * Currently, the blocks table has no primary key defined! - */ -function block_list($region, $regions = array('left' => 0, 'right' => 1, 'all' => '0, 1')) { +/** + * Return all blocks in the specified region for the current user. + * + * @param $region + * This is a string which describes in a human readable form which region + * you need. + * + * @param $regions + * This is an optional array and contains map(s) from the string $region to + * the numerical region value(s) in the blocks table. + * + * @return + * An array of block objects, indexed with module_delta. + * If you are displaying your blocks in one or two sidebars, you may check + * whether this array is empty to see how many columns are going to be + * displayed. + * + * @todo + * Add a proper primary key (bid) to the blocks table so we don't have + * to mess around with this module_delta construct. + * Currently, the blocks table has no primary key defined! + */ +function block_list($region) { global $user; + static $blocks = array(); if (!isset($blocks[$region])) { $blocks[$region] = array(); - $result = db_query("SELECT * FROM {blocks} WHERE status = 1 AND region IN (%s) ORDER BY weight, module", $regions[$region]); + $result = db_query("SELECT * FROM {blocks} WHERE status = 1 AND region = '%s' ORDER BY weight, module", $region); while ($block = db_fetch_array($result)) { // Use the user's block visibility setting, if necessary if ($block['custom'] != 0) { Index: modules/system.module =================================================================== RCS file: /cvs/drupal/drupal/modules/system.module,v retrieving revision 1.217 diff -u -r1.217 system.module --- modules/system.module 17 Jul 2005 20:57:43 -0000 1.217 +++ modules/system.module 18 Jul 2005 23:18:13 -0000 @@ -18,7 +18,7 @@ case 'admin/settings': return t('General configuration options for your site. Set up the name of the site, e-mail address used in mail-outs, clean URL options, caching, etc.
'); case 'admin/themes': - return t('Select which themes are available to your users and specify the default theme. To configure site-wide display settings, click the "configure" task above. Alternately, to override these settings in a specific theme, click the "configure" link for the corresponding theme.
'); + return t('Select which themes are available to your users and specify the default theme. To configure site-wide display settings, click the "configure" task above. Alternately, to override these settings in a specific theme, click the "configure" link for the corresponding theme. Note that different themes may have different regions available for rendering content like blocks. If you want consistency in what your users see, you may wish to enable only one theme.
'); case 'admin/themes/settings': return t('These options control the default display settings for your entire site, across all themes. Unless they have been overridden by a specific theme, these settings will be used.
'); case 'admin/themes/settings/'. arg(3): @@ -312,6 +312,7 @@ drupal_load('theme', $themes[$key]->name); $themes[$key]->owner = $themes[$key]->filename; $themes[$key]->prefix = $key; + $themes[$key]->regions = function_exists($key . '_regions') ? call_user_func($key . '_regions', 'list') : array(); } // Remove all theme engines from the system table @@ -323,17 +324,27 @@ drupal_load('theme_engine', $engine->name); db_query("INSERT INTO {system} (name, type, filename, status, throttle, bootstrap) VALUES ('%s', '%s', '%s', %d, %d, %d)", $engine->name, 'theme_engine', $engine->filename, 1, 0, 0); + // Load engine's regions + $engine->regions = function_exists($engine->name . '_regions') ? call_user_func($engine->name . '_regions', 'list') : array(); + // Add templates to the site listing foreach (call_user_func($engine->name . '_templates') as $template) { - $template->template = TRUE; - $template->name = basename(dirname($template->filename)); - $template->owner = $engine->filename; - $template->prefix = $engine->name; - // do not double-insert templates with theme files in their directory + // Do not double-insert templates with theme files in their directory, + // but do register their engine data. if (array_key_exists($template->name, $themes)) { + $themes[$template->name]->owner = $engine->filename; + $themes[$template->name]->prefix = $engine->name; + $themes[$template->name]->regions = array_merge($themes[$template->name]->regions, $engine->regions); continue; } - $themes[$template->name] = $template; + else { + $template->template = TRUE; + $template->name = basename(dirname($template->filename)); + $template->owner = $engine->filename; + $template->prefix = $engine->name; + $template->regions = $engine->regions; + $themes[$template->name] = $template; + } } } @@ -345,6 +356,7 @@ $style->name = basename(dirname($style->filename)); $style->owner = $theme->filename; $style->prefix = $theme->template ? $theme->prefix : $theme->name; + $style->regions = array(); // do not double-insert styles with theme files in their directory if (array_key_exists($style->name, $themes)) { continue; @@ -366,6 +378,103 @@ } /** + * Get a list of all defined regions. + * + * @param $theme_key + * The name of a theme. If none is set, regions from all themes are loaded. + * @param $asterix + * Boolean indicating if regions not available in the current theme should be + * asterixed. + * @param $scope + * Subset of regions to be loaded. Options are 'all', for all regions, 'module' + * for module-defined regions, and 'core' for only those regions available in all + * themes. + * @return + * An array of all regions. + */ +function system_region_list($theme_key = null, $asterix = false, $scope = 'all') { + global $theme, $theme_engine; + $regions = array(); + + // Load any module-defined regions. + $module_regions = module_invoke_all('regions'); + if ($asterix) { + // Double asterix regions defined by modules. + foreach ($regions as $key => $value) { + $module_regions[$key] .= '**'; + } + } + if ($scope == 'module') { + return $module_regions; + } + if (!$theme || !$theme_engine) { + $theme = init_theme(); + } + + $themes = system_theme_data(); + + // Load default theme's regions. This provides the initial population of the array, + // so that subsequent + $regions = array_merge($regions, $themes[$theme]->regions); + if($theme_key) { + $regions = array_merge($regions, $themes[$theme_key]->regions); + } + else { + foreach ($themes as $info) { + // Styles can't add their own regions. Include only enabled themes' regions. + if (!$info->style && $info->status) { + switch ($scope) { + case 'all': + $regions = array_merge($regions, $info->regions); + break; + case 'core': + $regions = array_intersect($regions, $info->regions); + break; + } + } + } + // Ensure default theme's region titles override other titles. + switch ($scope) { + case 'all': + $regions = array_merge($regions, $themes[$theme]->regions); + break; + case 'core': + $regions = array_intersect($themes[$theme]->regions, $regions); + break; + } + + if (($scope != 'core') && $asterix) { + foreach ($regions as $key => $value) { + // If the selected region is not one of the defined regions for the default theme, single asterix it. + if (!array_key_exists ($key, $themes[$theme]->regions)) { + $regions[$key] .= '*'; + } + } + } + } + return $regions; +} + +/** + * Get the name of the default region. + * + * @return + * A string that is the region name. + */ +function system_default_region() { + global $theme, $theme_engine; + + // If the theme defines its own default region, return it. + if (function_exists($theme . '_regions')) { + return call_user_func($theme . '_regions', 'default'); + } + // If there is an engine-defined region, return it. + elseif (function_exists($theme_engine . '_regions')) { + return call_user_func($theme_engine . '_regions', 'default'); + } + return; +} +/** * Returns an array of files objects of the given type from both the * site-wide directory (i.e. modules/) and site-specific directory * (i.e. sites/somesite/modules/). The returned array will be keyed Index: themes/chameleon/chameleon.theme =================================================================== RCS file: /cvs/drupal/drupal/themes/chameleon/chameleon.theme,v retrieving revision 1.30 diff -u -r1.30 chameleon.theme --- themes/chameleon/chameleon.theme 6 Jun 2005 14:07:04 -0000 1.30 +++ themes/chameleon/chameleon.theme 3 Jul 2005 18:41:15 -0000 @@ -16,6 +16,18 @@ 'toggle_secondary_links'); } +function chameleon_regions($op = 'list') { + switch ($op) { + case 'list': + return array( + 'left' => t('left sidebar'), + 'right' => t('right sidebar') + ); + case 'default': + return 'left'; + } +} + function chameleon_page($content) { $language = $GLOBALS['locale']; Index: themes/engines/phptemplate/phptemplate.engine =================================================================== RCS file: /cvs/drupal/drupal/themes/engines/phptemplate/phptemplate.engine,v retrieving revision 1.7 diff -u -r1.7 phptemplate.engine --- themes/engines/phptemplate/phptemplate.engine 17 Jul 2005 19:59:00 -0000 1.7 +++ themes/engines/phptemplate/phptemplate.engine 18 Jul 2005 22:14:37 -0000 @@ -17,6 +17,24 @@ return system_listing('^page\.tpl\.php$', $directory, 'filename'); } +function phptemplate_regions($op) { + switch ($op) { + case 'list': + return array( + 'left' => t('left sidebar'), + 'right' => t('right sidebar'), + 'messages' => t('messages'), + 'help' => t('help'), + 'content' => t('content'), + 'right' => t('right sidebar'), + 'footer' => t('footer'), + 'closure' => t('closure') + ); + case 'default': + return 'left'; + } +} + /** * Execute a template engine call. * @@ -68,6 +86,7 @@ * A sequential array of variables passed to the theme function. */ function _phptemplate_default_variables($hook, $variables) { + global $theme; static $count = array(); $count[$hook] = is_int($count[$hook]) ? $count[$hook] : 1; $variables['zebra'] = ($count[$hook] % 2) ? 'odd' : 'even'; @@ -79,7 +98,19 @@ $variables['block_zebra'] = ($count['block_counter'][$sidebar_indicator] % 2) ? 'odd' : 'even'; $variables['block_id'] = $count['block_counter'][$sidebar_indicator]++; } - + elseif ($hook == 'page') { + $regions = system_region_list($theme); + // Load all region content assigned via blocks. + foreach (system_region_list() as $region => $data) { + // If blocks in this region have already been loaded, don't reload them. + if (!in_array($region, array('left', 'right', 'footer'))) { + // If loaded region is present in current theme, set it. + if (array_key_exists($region, $regions)) { + $variables[$region] .= theme('blocks', $region); + } + } + } + } // Tell all templates where they are located. $variables['directory'] = path_to_theme(); @@ -168,7 +199,7 @@ 'sidebar_left' => $sidebar_left, 'content' => '' . $content . '', 'sidebar_right' => $sidebar_right, - 'footer_message' => variable_get('site_footer', FALSE), + 'footer_message' => variable_get('site_footer', FALSE) . "\n" . theme('blocks', 'footer'), 'closure' => theme('closure') ); if ((arg(0) == 'node') && is_int(arg(1))) {