block--help.html.twig

Same filename in other branches
  1. 8.9.x core/profiles/demo_umami/themes/umami/templates/components/help-block/block--help.html.twig
  2. 10 core/profiles/demo_umami/themes/umami/templates/components/help-block/block--help.html.twig
  3. 11.x core/profiles/demo_umami/themes/umami/templates/components/help-block/block--help.html.twig

Theme override for help messages.

Available variables:

  • plugin_id: The ID of the block implementation.
  • label: The configured label of the block if visible.
  • configuration: A list of the block's configuration values.
    • label: The configured label for the block.
    • label_display: The display settings for the label.
    • provider: The module or other provider that provided this block plugin.
    • Block plugin specific settings will also be stored here.
  • in_preview: Whether the plugin is being rendered in preview mode.
  • content: The content of this block.
  • attributes: array of HTML attributes populated by modules, intended to be added to the main container tag of this template.

    • id: A valid HTML ID and guaranteed unique.
  • title_attributes: Same as attributes, except applied to the main title tag that appears in the template.
  • title_prefix: Additional output populated by modules, intended to be displayed in front of the main title tag that appears in the template.
  • title_suffix: Additional output populated by modules, intended to be displayed after the main title tag that appears in the template.

See also

template_preprocess_block()

File

core/profiles/demo_umami/themes/umami/templates/components/help-block/block--help.html.twig

View source
  1. {#
  2. /**
  3. * @file
  4. * Theme override for help messages.
  5. *
  6. * Available variables:
  7. * - plugin_id: The ID of the block implementation.
  8. * - label: The configured label of the block if visible.
  9. * - configuration: A list of the block's configuration values.
  10. * - label: The configured label for the block.
  11. * - label_display: The display settings for the label.
  12. * - provider: The module or other provider that provided this block plugin.
  13. * - Block plugin specific settings will also be stored here.
  14. * - in_preview: Whether the plugin is being rendered in preview mode.
  15. * - content: The content of this block.
  16. * - attributes: array of HTML attributes populated by modules, intended to
  17. * be added to the main container tag of this template.
  18. * - id: A valid HTML ID and guaranteed unique.
  19. * - title_attributes: Same as attributes, except applied to the main title
  20. * tag that appears in the template.
  21. * - title_prefix: Additional output populated by modules, intended to be
  22. * displayed in front of the main title tag that appears in the template.
  23. * - title_suffix: Additional output populated by modules, intended to be
  24. * displayed after the main title tag that appears in the template.
  25. *
  26. * @see template_preprocess_block()
  27. */
  28. #}
  29. {%
  30. set classes = [
  31. 'block',
  32. 'block-' ~ configuration.provider|clean_class,
  33. 'block-' ~ plugin_id|clean_class,
  34. ]
  35. %}
  36. <div{{ attributes.addClass(classes) }}>
  37. <div class="block-help__container">
  38. {{ title_prefix }}
  39. {% if label %}
  40. <h2{{ title_attributes }}>{{ label }}</h2>
  41. {% endif %}
  42. {{ title_suffix }}
  43. {% block content %}
  44. {{ content }}
  45. {% endblock %}
  46. </div>
  47. </div>

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