function FormElement::preRenderAjaxForm

Same name and namespace in other branches
  1. 10 core/lib/Drupal/Core/Render/Element/FormElement.php \Drupal\Core\Render\Element\FormElement::preRenderAjaxForm()

Adds Ajax information about an element to communicate with JavaScript.

If #ajax is set on an element, this additional JavaScript is added to the page header to attach the Ajax behaviors. See ajax.js for more information.

Parameters

array $element: An associative array containing the properties of the element. Properties used:

  • "#ajax['event']".
  • "#ajax['prevent']".
  • "#ajax['url']".
  • "#ajax['httpMethod']".
  • "#ajax['callback']".
  • "#ajax['options']".
  • "#ajax['wrapper']".
  • "#ajax['parameters']".
  • "#ajax['effect']".
  • "#ajax['accepts']".

Return value

array The processed element with the necessary JavaScript attached to it.

Overrides RenderElementBase::preRenderAjaxForm

File

core/lib/Drupal/Core/Render/Element/FormElement.php, line 52

Class

FormElement
Provides a base class for form element plugins.

Namespace

Drupal\Core\Render\Element

Code

public static function preRenderAjaxForm($element) {
  @trigger_error('\\Drupal\\Core\\Render\\Element\\FormElement::preRenderAjaxForm() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\Core\\Render\\Element\\FormElementBase::preRenderAjaxForm() instead. See https://www.drupal.org/node/3436275', E_USER_DEPRECATED);
  return parent::preRenderAjaxForm($element);
}

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