Provides a standard HTML class name that identifies a page region.

It is recommended that template preprocess functions apply this class to any page region that is output by the theme (Drupal core already handles this in the standard template preprocess implementation). Standardizing the class names in this way allows modules to implement certain features, such as drag-and-drop or dynamic Ajax loading, in a theme-independent way.

Parameters

$region: The name of the page region (for example, 'page_top' or 'content').

Return value

An HTML class that identifies the region (for example, 'region-page-top' or 'region-content').

See also

template_preprocess_region()

2 calls to drupal_region_class()
overlay_request_refresh in modules/overlay/overlay.module
Requests that the parent window refreshes a particular page region.
template_preprocess_region in includes/theme.inc
Preprocess variables for region.tpl.php

File

includes/common.inc, line 4178
Common functions that many Drupal modules will need to reference.

Code

function drupal_region_class($region) {
  return drupal_html_class("region-{$region}");
}