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

Provides a render element for adding Ajax to a render element.

Holds an array whose values control the Ajax behavior of the element.

Plugin annotation

@RenderElement("ajax");

Hierarchy

Expanded class hierarchy of Ajax

Related topics

File

core/lib/Drupal/Core/Render/Element/Ajax.php, line 14

Namespace

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

  /**
   * {@inheritdoc}
   */
  public function getInfo() {

    // By default, we don't want Ajax commands being rendered in the context of
    // an HTML page, so we don't provide defaults for #theme or #theme_wrappers.
    // However, modules can set these properties (for example, to provide an
    // HTML debugging page that displays rather than executes Ajax commands).
    return [
      '#header' => TRUE,
      '#commands' => [],
      '#error' => NULL,
    ];
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
Ajax::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
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
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.