You are here

class StatusMessages in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Render/Element/StatusMessages.php \Drupal\Core\Render\Element\StatusMessages
  2. 9 core/lib/Drupal/Core/Render/Element/StatusMessages.php \Drupal\Core\Render\Element\StatusMessages

Provides a messages element.

Used to display results of \Drupal::messenger()->addMessage() 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/quickedit/src/Controller/QuickEditImageController.php
27 #type uses of StatusMessages
AddFormBase::buildForm in core/modules/media_library/src/Form/AddFormBase.php
Form constructor.
AjaxFormHelperTrait::ajaxSubmit in core/lib/Drupal/Core/Ajax/AjaxFormHelperTrait.php
Submit form dialog #ajax callback.
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
BigPipePlaceholderTestCases::cases in core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php
Gets all BigPipe placeholder test cases.

... 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',
      ],
      '#include_fallback' => FALSE,
    ];
  }

  /**
   * #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) {
    $build = [
      '#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.
    $build = \Drupal::service('render_placeholder_generator')
      ->createPlaceholder($build);
    if ($element['#include_fallback']) {
      return [
        'fallback' => [
          '#markup' => '<div data-drupal-messages-fallback class="hidden"></div>',
        ],
        'messages' => $build,
      ];
    }
    return $build;
  }

  /**
   * #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\Core\Messenger\Messenger::deleteByType(). These
   *   values are supported:
   *   - NULL
   *   - 'status'
   *   - 'warning'
   *   - 'error'
   *
   * @return array
   *   A renderable array containing the messages.
   *
   * @see \Drupal\Core\Messenger\Messenger::deleteByType()
   */
  public static function renderMessages($type = NULL) {
    $render = [];
    if (isset($type)) {
      $messages = [
        $type => \Drupal::messenger()
          ->deleteByType($type),
      ];
    }
    else {
      $messages = \Drupal::messenger()
        ->deleteAll();
    }
    if ($messages) {

      // Render the messages.
      $render = [
        '#theme' => 'status_messages',
        '#message_list' => $messages,
        '#status_headings' => [
          'status' => t('Status message'),
          'error' => t('Error message'),
          'warning' => t('Warning message'),
        ],
      ];
    }
    return $render;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 18
MessengerTrait::messenger public function Gets the messenger. 18
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.
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
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 2
PluginBase::getPluginId public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 53
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
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. 3
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. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.