Issue #2065485 by tim.plunkett, Xano: Document that PluginFormInterface should use #process to solve nesting issues.

8.0.x
Nathaniel Catchpole 2014-10-21 10:29:31 +01:00
parent 45ebdf02cc
commit fdb67c2857
1 changed files with 11 additions and 0 deletions

View File

@ -12,6 +12,17 @@ use Drupal\Core\Form\FormStateInterface;
/**
* Provides an interface for a plugin that contains a form.
*
* Plugin forms are usually contained in other forms. In order to know where the
* plugin form is located in the parent form, #parents and #array_parents must
* be known, but these are not available during the initial build phase. In
* order to have these properties available when building the plugin form's
* elements, let buildConfigurationForm() return a form element that has a
* #process callback and build the rest of the form in the callback. By the time
* the callback is executed, the element's #parents and #array_parents
* properties will have been set by the form API. For more documentation on
* #parents and #array_parents, see
* https://api.drupal.org/api/drupal/developer!topics!forms_api_reference.html/8.
*
* @ingroup plugin_api
*/
interface PluginFormInterface {