function FormOperations::formAlter

Same name in this branch
  1. 11.x core/modules/workspaces/src/FormOperations.php \Drupal\workspaces\FormOperations::formAlter()
Same name and namespace in other branches
  1. 9 core/modules/workspaces/src/FormOperations.php \Drupal\workspaces\FormOperations::formAlter()
  2. 8.9.x core/modules/workspaces/src/FormOperations.php \Drupal\workspaces\FormOperations::formAlter()
  3. 10 core/modules/workspaces/src/FormOperations.php \Drupal\workspaces\FormOperations::formAlter()

Implements hook_form_alter().

Attributes

#[Hook('form_alter')]

File

core/modules/workspaces/src/Hook/FormOperations.php, line 25

Class

FormOperations
Defines a class for reacting to form operations.

Namespace

Drupal\workspaces\Hook

Code

public function formAlter(array &$form, FormStateInterface $form_state, $form_id) : void {
  // No alterations are needed if we're not in a workspace context.
  if (!$this->workspaceManager
    ->hasActiveWorkspace()) {
    return;
  }
  // If a form hasn't already been marked as safe or not to submit in a
  // workspace, check the generic interfaces.
  if (!$form_state->has('workspace_safe')) {
    $form_object = $form_state->getFormObject();
    $workspace_safe = $form_object instanceof WorkspaceSafeFormInterface || $form_object instanceof WorkspaceDynamicSafeFormInterface && $form_object->isWorkspaceSafeForm($form, $form_state);
    $form_state->set('workspace_safe', $workspace_safe);
  }
  // Add a validation step for every other form.
  if ($form_state->get('workspace_safe') !== TRUE) {
    $form['workspace_safe'] = [
      '#type' => 'value',
      '#value' => FALSE,
    ];
    $this->addWorkspaceValidation($form);
  }
}

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