class Ajax

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/Ajax.php \Drupal\Core\Render\Element\Ajax
  2. 8.9.x core/lib/Drupal/Core/Render/Element/Ajax.php \Drupal\Core\Render\Element\Ajax
  3. 10 core/lib/Drupal/Core/Render/Element/Ajax.php \Drupal\Core\Render\Element\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



Expanded class hierarchy of Ajax


in drupal:10.1.0 and is removed from drupal:11.0.0. Return an \Drupal\Core\Ajax\AjaxResponse instead.

See also

Related topics

15 string references to 'Ajax'
AjaxRenderer::renderResponse in core/lib/Drupal/Core/Render/MainContent/AjaxRenderer.php
Renders the main content render array into a response.
DisplayPluginBase::buildOptionsForm in core/modules/views/src/Plugin/views/display/DisplayPluginBase.php
Provide a form to edit options for this plugin.
EntitySerializationTest::testSerialize in core/modules/serialization/tests/src/Kernel/EntitySerializationTest.php
Tests entity serialization for core's formats by a registered Serializer.
ExposedFormPluginBase::renderExposedForm in core/modules/views/src/Plugin/views/exposed_form/ExposedFormPluginBase.php
Renders the exposed form.
FormBuilderTest::testGetAjaxRequest in core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php
@covers ::buildForm

... See full list


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


View source
class Ajax extends RenderElement {
     * {@inheritdoc}
    public function __construct(array $configuration, $plugin_id, $plugin_definition) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        @trigger_error('\\Drupal\\Core\\Render\\Element\\Ajax is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Return an \\Drupal\\Core\\Ajax\\AjaxResponse instead. See', E_USER_DEPRECATED);
     * {@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,



Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Ajax::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Ajax::__construct public function Overrides RenderElement::__construct
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. Overrides RenderElementBase::preRenderAjaxForm
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering. Overrides RenderElementBase::preRenderGroup
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. Overrides RenderElementBase::processAjaxForm
RenderElement::processGroup public static function Arranges elements into groups. Overrides RenderElementBase::processGroup
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides RenderElementBase::setAttributes

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