1. 8.2.x core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php FieldFormatter
  2. 8.0.x core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php FieldFormatter
  3. 8.1.x core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php FieldFormatter
  4. 8.3.x core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php FieldFormatter

Defines a FieldFormatter annotation object.

Formatters handle the display of field values. They are typically instantiated and invoked by an EntityDisplay object.

Additional annotation keys for formatters can be defined in hook_field_formatter_info_alter().

Hierarchy

Expanded class hierarchy of FieldFormatter

See also

\Drupal\Core\Field\FormatterPluginManager

\Drupal\Core\Field\FormatterInterface

Related topics

57 classes are annotated with FieldFormatter
AggregatorTitleFormatter in core/modules/aggregator/src/Plugin/Field/FieldFormatter/AggregatorTitleFormatter.php
Plugin implementation of the 'aggregator_title' formatter.
AggregatorXSSFormatter in core/modules/aggregator/src/Plugin/Field/FieldFormatter/AggregatorXSSFormatter.php
Plugin implementation of the 'aggregator_xss' formatter.
AttachmentTestFormatter in core/modules/views/tests/modules/views_test_formatter/src/Plugin/Field/FieldFormatter/AttachmentTestFormatter.php
Plugin implementation of the 'number_unformatted_with_attachment' formatter.
AuthorFormatter in core/modules/user/src/Plugin/Field/FieldFormatter/AuthorFormatter.php
Plugin implementation of the 'author' formatter.
AuthorNameFormatter in core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php
Plugin implementation of the 'comment_username' formatter.

... See full list

File

core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php, line 23

Namespace

Drupal\Core\Field\Annotation
View source
class FieldFormatter extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the formatter type.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * A short description of the formatter type.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * The name of the field formatter class.
   *
   * This is not provided manually, it will be added by the discovery mechanism.
   *
   * @var string
   */
  public $class;

  /**
   * An array of field types the formatter supports.
   *
   * @var array
   */
  public $field_types = array();

  /**
   * An integer to determine the weight of this formatter relative to other
   * formatter in the Field UI when selecting a formatter for a given field
   * instance.
   *
   * @var int optional
   */
  public $weight = NULL;

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
FieldFormatter::$class public property The name of the field formatter class.
FieldFormatter::$description public property A short description of the formatter type.
FieldFormatter::$field_types public property An array of field types the formatter supports.
FieldFormatter::$id public property The plugin ID.
FieldFormatter::$label public property The human-readable name of the formatter type.
FieldFormatter::$weight public property An integer to determine the weight of this formatter relative to other formatter in the Field UI when selecting a formatter for a given field instance.
Plugin::$definition protected property The plugin definition read from the class annotation.
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object.