function hook_entity_form_display_alter

Alters the settings used for displaying an entity form.

Parameters

\Drupal\entity\Plugin\Core\Entity\EntityFormDisplay $form_display: The entity_form_display object that will be used to display the entity form components.

array $context: An associative array containing:

  • entity_type: The entity type, e.g., 'node' or 'user'.
  • bundle: The bundle, e.g., 'page' or 'article'.
  • form_mode: The form mode, e.g. 'default', 'profile', 'register'...

Related topics

Hooks
Allow modules to interact with the Drupal core.
1 function implements hook_entity_form_display_alter()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

entity_test_entity_form_display_alter in drupal/core/modules/system/tests/modules/entity_test/entity_test.module
Implements hook_entity_form_display_alter().

File

drupal/core/includes/entity.api.php, line 466
Hooks provided the Entity module.

Code

function hook_entity_form_display_alter(\Drupal\entity\Plugin\Core\Entity\EntityFormDisplay $form_display, array $context) {

  // Hide the 'user_picture' field from the register form.
  if ($context['entity_type'] == 'user' && $context['form_mode'] == 'register') {
    $form_display
      ->setComponent('user_picture', array(
      'type' => 'hidden',
    ));
  }
}