class Html

Same name in this branch

9 core/lib/Drupal/Component/Utility/Html.php \Drupal\Component\Utility\Html

Same name and namespace in other branches

8.9.x core/lib/Drupal/Core/Render/Element/Html.php \Drupal\Core\Render\Element\Html
8.9.x core/lib/Drupal/Component/Utility/Html.php \Drupal\Component\Utility\Html
10 core/lib/Drupal/Core/Render/Element/Html.php \Drupal\Core\Render\Element\Html
10 core/lib/Drupal/Component/Utility/Html.php \Drupal\Component\Utility\Html
11.x core/lib/Drupal/Core/Render/Element/Html.php \Drupal\Core\Render\Element\Html
11.x core/lib/Drupal/Component/Utility/Html.php \Drupal\Component\Utility\Html

Provides a render element for an entire HTML page: <html> plus its children.

Plugin annotation

@RenderElement("html");

Hierarchy

class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
  - class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Render\Element\ElementInterface implements \Drupal\Core\Plugin\PluginBase
    - class \Drupal\Core\Render\Element\Html implements \Drupal\Core\Render\Element\RenderElement

Expanded class hierarchy of Html

60 string references to 'Html'

AcceptHeaderMatcherTest::acceptFilterProvider in core/tests/Drupal/Tests/Core/Routing/AcceptHeaderMatcherTest.php: Provides data for the Accept header filtering test.
AcceptHeaderMiddleware::handle in core/modules/system/tests/modules/accept_header_routing_test/src/AcceptHeaderMiddleware.php
AdminRouteSubscriber::isHtmlRoute in core/modules/system/src/EventSubscriber/AdminRouteSubscriber.php: Determines whether the given route is an HTML route.
AdminRouteSubscriberTest::providerTestAlterRoutes in core/modules/system/tests/src/Unit/Routing/AdminRouteSubscriberTest.php
AjaxCommandsTest::testHtmlCommand in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php: @covers \Drupal\Core\Ajax\HtmlCommand[[api-linebreak]]

... See full list

2 #type uses of Html

BareHtmlPageRenderer::renderBarePage in core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php: Renders a bare page.
HtmlRenderer::renderResponse in core/lib/Drupal/Core/Render/MainContent/HtmlRenderer.php: The entire HTML: takes a #type 'page' and wraps it in a #type 'html'.

File

core/lib/Drupal/Core/Render/Element/Html.php, line 10

Namespace

Drupal\Core\Render\Element

View on git.drupalcode.org

View source

class Html extends RenderElement {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#theme' => 'html',
    ];
  }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
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			2
DependencySerializationTrait::__wakeup	public	function	#[\ReturnTypeWillChange]		2
Html::getInfo	public	function	Returns the element properties for this element.	Overrides ElementInterface::getInfo
MessengerTrait::$messenger	protected	property	The messenger.		27
MessengerTrait::messenger	public	function	Gets the messenger.		27
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	2
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.		85
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.		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.		2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

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

Breadcrumb