class 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

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

Expanded class hierarchy of Ajax

Related topics

File

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

Namespace

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