1. 8.5.x core/lib/Drupal/Core/Render/Element/StatusMessages.php StatusMessages
  2. 8.0.x core/lib/Drupal/Core/Render/Element/StatusMessages.php StatusMessages
  3. 8.1.x core/lib/Drupal/Core/Render/Element/StatusMessages.php StatusMessages
  4. 8.2.x core/lib/Drupal/Core/Render/Element/StatusMessages.php StatusMessages
  5. 8.3.x core/lib/Drupal/Core/Render/Element/StatusMessages.php StatusMessages
  6. 8.4.x core/lib/Drupal/Core/Render/Element/StatusMessages.php StatusMessages
  7. 8.6.x core/lib/Drupal/Core/Render/Element/StatusMessages.php StatusMessages

Provides a messages element.

Used to display results of drupal_set_message() calls.

Usage example:

$build['status_messages'] = [
  '#type' => 'status_messages',
];

Plugin annotation

@RenderElement("status_messages");

Hierarchy

Expanded class hierarchy of StatusMessages

1 file declares its use of StatusMessages
QuickEditImageController.php in core/modules/image/src/Controller/QuickEditImageController.php
20 #type uses of StatusMessages
AjaxRenderer::renderResponse in core/lib/Drupal/Core/Render/MainContent/AjaxRenderer.php
Renders the main content render array into a response.
BareHtmlPageRenderer::renderBarePage in core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php
Renders a bare page.
BlockEntityOffCanvasForm::submitFormDialog in core/modules/settings_tray/src/Block/BlockEntityOffCanvasForm.php
Submit form dialog #ajax callback.
BlockPageVariant::build in core/modules/block/src/Plugin/DisplayVariant/BlockPageVariant.php
Builds and returns the renderable array for the display variant.
BlockPageVariantTest::providerBuild in core/modules/block/tests/src/Unit/Plugin/DisplayVariant/BlockPageVariantTest.php

... See full list

File

core/lib/Drupal/Core/Render/Element/StatusMessages.php, line 19

Namespace

Drupal\Core\Render\Element
View source
class StatusMessages extends RenderElement {

  /**
   * {@inheritdoc}
   *
   * Generate the placeholder in a #pre_render callback, because the hash salt
   * needs to be accessed, which may not yet be available when this is called.
   */
  public function getInfo() {
    return [
      // May have a value of 'status' or 'error' when only displaying messages
      // of that specific type.
      '#display' => NULL,
      '#pre_render' => [
        get_class() . '::generatePlaceholder',
      ],
    ];
  }

  /**
   * #pre_render callback to generate a placeholder.
   *
   * @param array $element
   *   A renderable array.
   *
   * @return array
   *   The updated renderable array containing the placeholder.
   */
  public static function generatePlaceholder(array $element) {
    $element = [
      '#lazy_builder' => [
        get_class() . '::renderMessages',
        [
          $element['#display'],
        ],
      ],
      '#create_placeholder' => TRUE,
    ];

    // Directly create a placeholder as we need this to be placeholdered
    // regardless if this is a POST or GET request.
    // @todo remove this when https://www.drupal.org/node/2367555 lands.
    return \Drupal::service('render_placeholder_generator')
      ->createPlaceholder($element);
  }

  /**
   * #lazy_builder callback; replaces placeholder with messages.
   *
   * @param string|null $type
   *   Limit the messages returned by type. Defaults to NULL, meaning all types.
   *   Passed on to drupal_get_messages(). These values are supported:
   *   - NULL
   *   - 'status'
   *   - 'warning'
   *   - 'error'
   *
   * @return array
   *   A renderable array containing the messages.
   *
   * @see drupal_get_messages()
   */
  public static function renderMessages($type) {
    $render = [];
    $messages = drupal_get_messages($type);
    if ($messages) {

      // Render the messages.
      $render = [
        '#theme' => 'status_messages',
        // @todo Improve when https://www.drupal.org/node/2278383 lands.
        '#message_list' => $messages,
        '#status_headings' => [
          'status' => t('Status message'),
          'error' => t('Error message'),
          'warning' => t('Warning message'),
        ],
      ];
    }
    return $render;
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties.
DependencySerializationTrait::__wakeup public function
PluginBase::$configuration protected property Configuration information passed into the plugin.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
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
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object.
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.
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StatusMessages::generatePlaceholder public static function #pre_render callback to generate a placeholder.
StatusMessages::getInfo public function Generate the placeholder in a #pre_render callback, because the hash salt needs to be accessed, which may not yet be available when this is called. Overrides ElementInterface::getInfo
StatusMessages::renderMessages public static function #lazy_builder callback; replaces placeholder with messages.
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.