interface MarkupInterface in Drupal 10

Marks an object's __toString() method as returning markup.

Objects that implement this interface will not be automatically XSS filtered by the render system or automatically escaped by the theme engine.

If there is any risk of the object's __toString() method returning user-entered data that has not been filtered first, it must not be used. If the object that implements this does not perform automatic escaping or filtering itself, then it must be marked as "@internal". For example, Views has the internal ViewsRenderPipelineMarkup object to provide a custom render pipeline in order to render JSON and to fast render fields. By contrast, FormattableMarkup and TranslatableMarkup always sanitize their output when used correctly.

If the object is going to be used directly in Twig templates it should implement \Countable so it can be used in if statements.

Hierarchy

• interface \Drupal\Component\Render\MarkupInterface extends \Drupal\Component\Render\JsonSerializable

See also

\Drupal\Component\Render\MarkupTrait

\Drupal\Core\Template\TwigExtension::escapeFilter()

\Drupal\Component\Render\FormattableMarkup

\Drupal\Core\StringTranslation\TranslatableMarkup

\Drupal\views\Render\ViewsRenderPipelineMarkup

twig_render_template()

sanitization

Render API overview

35 files declare their use of MarkupInterface

Attribute.php in core/lib/Drupal/Core/Template/Attribute.php

AttributeTest.php in core/tests/Drupal/Tests/Core/Template/AttributeTest.php

AuditResult.php in core/modules/migrate/src/Audit/AuditResult.php

BigPipeMarkup.php in core/modules/big_pipe/src/Render/BigPipeMarkup.php

CommentPreviewTest.php in core/modules/comment/tests/src/Functional/CommentPreviewTest.php

... See full list

File

core/lib/Drupal/Component/Render/MarkupInterface.php, line 32

Namespace

Drupal\Component\Render

interface MarkupInterface extends \JsonSerializable {

  /**
   * Returns markup.
   *
   * @return string
   *   The markup.
   */
  public function __toString();

}