function NodeFieldHooks::preConfiguredDescription

Implements hook_field_ui_preconfigured_options_alter().

Attributes

#[Hook('field_ui_preconfigured_options_alter')]

File

core/modules/node/src/Hook/NodeFieldHooks.php, line 26

Class

NodeFieldHooks
Field and Field UI hook implementations for Node module.

Namespace

Drupal\node\Hook

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['node'])) {
    $options['node']['description'] = [
      $this->t('Link content'),
      $this->t('Examples: related articles, next/previous links'),
    ];
  }
}

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