class Container in Drupal 8

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'),
];

Plugin annotation

@RenderElement("container");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\Container

2 string references to 'Container'

field.field.taxonomy_term.forums.forum_container.yml in core/modules/forum/config/optional/field.field.taxonomy_term.forums.forum_container.yml

core/modules/forum/config/optional/field.field.taxonomy_term.forums.forum_container.yml

SearchExcerptTest::testSearchExcerptSimplified in core/modules/search/tests/src/Kernel/SearchExcerptTest.php

Tests search_excerpt() with search keywords matching simplified words.

81 #type uses of Container

AccountForm::form in core/modules/user/src/AccountForm.php

Gets the actual form array to be built.

AccountSettingsForm::buildForm in core/modules/user/src/AccountSettingsForm.php

Form constructor.

ActionAjaxTest::buildConfigurationForm in core/modules/action/tests/action_form_ajax_test/src/Plugin/Action/ActionAjaxTest.php

Form constructor.

AddFormBase::buildEntityFormElement in core/modules/media_library/src/Form/AddFormBase.php

Builds the sub-form for setting required fields on a new media item.

AddFormBase::buildSelectedItemElement in core/modules/media_library/src/Form/AddFormBase.php

Returns a render array for a single pre-selected media item.

... See full list

File

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

Namespace

Drupal\Core\Render\Element

class Container extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    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

Name	Modifiers	Type	Description	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.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.