overlay_set_regions_to_render

Sets the regions of the page that rendering will be limited to.

Parameters

$regions: (Optional) An array containing the names of the regions that should be rendered when drupal_render_page() is called. Pass in an empty array to remove all limits and cause drupal_render_page() to render all page regions (the default behavior). If this parameter is omitted, no change will be made to the current list of regions to render.

Return value

The current list of regions to render, or an empty array if the regions are not being limited.

See also

overlay_page_alter()

overlay_block_list_alter()

overlay_get_regions_to_render()

3 calls to overlay_set_regions_to_render()

File

modules/overlay/overlay.module, line 818

Displays the Drupal administration interface in an overlay.

Code

function overlay_set_regions_to_render($regions = NULL) {
  $regions_to_render = &drupal_static(__FUNCTION__, array());
  if (isset($regions)) {
    $regions_to_render = $regions;
  }
  return $regions_to_render;
}