class Container

Same name in this branch
  1. 10 core/lib/Drupal/Core/DependencyInjection/Container.php \Drupal\Core\DependencyInjection\Container
  2. 10 core/lib/Drupal/Component/DependencyInjection/Container.php \Drupal\Component\DependencyInjection\Container
Same name and namespace in other branches
  1. 7.x misc/typo3/phar-stream-wrapper/src/Phar/Container.php \TYPO3\PharStreamWrapper\Phar\Container
  2. 9 core/lib/Drupal/Core/Render/Element/Container.php \Drupal\Core\Render\Element\Container
  3. 9 core/lib/Drupal/Core/DependencyInjection/Container.php \Drupal\Core\DependencyInjection\Container
  4. 9 core/lib/Drupal/Component/DependencyInjection/Container.php \Drupal\Component\DependencyInjection\Container
  5. 8.9.x core/lib/Drupal/Core/Render/Element/Container.php \Drupal\Core\Render\Element\Container
  6. 8.9.x core/lib/Drupal/Core/DependencyInjection/Container.php \Drupal\Core\DependencyInjection\Container
  7. 8.9.x core/lib/Drupal/Component/DependencyInjection/Container.php \Drupal\Component\DependencyInjection\Container
  8. 11.x core/lib/Drupal/Core/Render/Element/Container.php \Drupal\Core\Render\Element\Container
  9. 11.x core/lib/Drupal/Core/DependencyInjection/Container.php \Drupal\Core\DependencyInjection\Container
  10. 11.x core/lib/Drupal/Component/DependencyInjection/Container.php \Drupal\Component\DependencyInjection\Container

Provides a render element that wraps child elements in a container.

Surrounds child elements with a <div> and adds attributes such as classes or an HTML ID.

Properties:

  • #optional: Indicates whether the container should render when it has no visible children. Defaults to FALSE.

Usage example:

$form['needs_accommodation'] = [
  '#type' => 'checkbox',
  '#title' => $this->t('Need Special Accommodations?'),
];
$form['accommodation'] = [
  '#type' => 'container',
  '#attributes' => [
    'class' => [
      'accommodation',
    ],
  ],
  '#states' => [
    'invisible' => [
      'input[name="needs_accommodation"]' => [
        'checked' => FALSE,
      ],
    ],
  ],
];
$form['accommodation']['diet'] = [
  '#type' => 'textfield',
  '#title' => $this->t('Dietary Restrictions'),
];

Hierarchy

Expanded class hierarchy of Container

41 string references to 'Container'
Actions::getInfo in core/lib/Drupal/Core/Render/Element/Actions.php
Returns the element properties for this element.
AddHandler::buildForm in core/modules/views_ui/src/Form/Ajax/AddHandler.php
Form constructor.
ArgumentPluginBase::buildOptionsForm in core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php
Provide a form to edit options for this plugin.
ChooseBlockController::build in core/modules/layout_builder/src/Controller/ChooseBlockController.php
Provides the UI for choosing a new block.
ClaroPreRender::trustedCallbacks in core/themes/claro/src/ClaroPreRender.php
Lists the trusted callbacks provided by the implementing class.

... See full list

File

core/lib/Drupal/Core/Render/Element/Container.php, line 45

Namespace

Drupal\Core\Render\Element
View on git.drupalcode.org
View source 
class Container extends RenderElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#optional' => FALSE,
      '#process' => [
        [
          $class,
          'processGroup',
        ],
        [
          $class,
          'processContainer',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderGroup',
        ],
        [
          $class,
          'preRenderContainer',
        ],
      ],
      '#theme_wrappers' => [
        'container',
      ],
    ];
  }
  
  /**
   * Processes a container element.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   container.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   */
  public static function processContainer(&$element, FormStateInterface $form_state, &$complete_form) {
    // Generate the ID of the element if it's not explicitly given.
    if (!isset($element['#id'])) {
      $element['#id'] = HtmlUtility::getUniqueId(implode('-', $element['#parents']) . '-wrapper');
    }
    return $element;
  }
  
  /**
   * Prevents optional containers from rendering if they have no children.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   container.
   *
   * @return array
   *   The modified element.
   */
  public static function preRenderContainer($element) {
    // Do not render optional container elements if there are no children.
    if (empty($element['#printed']) && !empty($element['#optional']) && !Element::getVisibleChildren($element)) {
      $element['#printed'] = TRUE;
    }
    return $element;
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
Container::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo 1
Container::preRenderContainer public static function Prevents optional containers from rendering if they have no children.
Container::processContainer public static function Processes a container element.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
RenderElementBase::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. 2
RenderElementBase::preRenderGroup public static function Adds members of this group as actual elements for rendering. 2
RenderElementBase::processAjaxForm public static function Form element processing handler for the #ajax form property. 3
RenderElementBase::processGroup public static function Arranges elements into groups. 2
RenderElementBase::setAttributes public static function Sets a form element&#039;s class attribute. Overrides ElementInterface::setAttributes 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.