function UserFieldHooks::preConfiguredDescription

Implements hook_field_ui_preconfigured_options_alter().

Attributes

File

core/modules/user/src/Hook/UserFieldHooks.php, line 26

Class

UserFieldHooks

Field and Field UI hook implementations for User module.

Namespace

Code

public function preConfiguredDescription(array &$options, $field_type) : void {
  // If the field is not an "entity_reference"-based field, then bail out.
  $class = $this->fieldTypeManager
    ->getPluginClass($field_type);
  if (!is_a($class, EntityReferenceItem::class, TRUE)) {
    return;
  }
  // Set the description for the "Add field" page.
  if (!empty($options['user'])) {
    $options['user']['description'] = [
      $this->t('Refer to any user on the site'),
      $this->t("Examples: show the user's email address or a link to their contact form"),
    ];
  }
}