function theme_container

Returns HTML to wrap child elements in a container.

Used for grouped form items. Can also be used as a theme wrapper for any renderable element, to surround it with a <div> and add attributes such as classes or an HTML id.

See the Form API reference for more information on the #theme_wrappers render array property.

Parameters

$variables: An associative array containing:

• element: An associative array containing the properties of the element. Properties used: #id, #attributes, #children.

Related topics

File

includes/form.inc, line 3630

Functions for form and batch generation and processing.

Code

function theme_container($variables) {
  $element = $variables['element'];
  // Ensure #attributes is set.
  $element += array('#attributes' => array());

  // Special handling for form elements.
  if (isset($element['#array_parents'])) {
    // Assign an html ID.
    if (!array_key_exists('id', $element['#attributes'])) {
      $element['#attributes']['id'] = $element['#id'];
    }
    // Add the form-wrapper class.
    if (empty($element['#attributes']['class'])) {
      $element['#attributes']['class'][] = 'form-wrapper';
    }
  }

  return '<div' . backdrop_attributes($element['#attributes']) . '>' . $element['#children'] . '</div>';
}