function overlay_supplemental_regions in Drupal 7

Returns a list of supplemental page regions for the overlay.

Supplemental overlay regions are those which are technically part of the parent window, but appear to the user as being related to the overlay (usually because they are displayed next to, rather than underneath, the main overlay regions) and therefore need to be dynamically refreshed if any administrative actions taken within the overlay change their contents.

An example of a typical overlay supplemental region would be the 'page_top' region, in the case where a toolbar is being displayed there.

Return value

An array of region names that correspond to supplemental overlay regions, within the theme that is being used to display the current page.

See also

overlay_regions()

2 calls to overlay_supplemental_regions()

overlay_exit in modules/overlay/overlay.module

Implements hook_exit().

overlay_overlay_child_initialize in modules/overlay/overlay.module

Implements hook_overlay_child_initialize().

File

modules/overlay/overlay.module, line 790

Displays the Drupal administration interface in an overlay.

Code

function overlay_supplemental_regions() {
  return _overlay_region_list('overlay_supplemental_regions');
}