class FieldFormatter

Same name in this branch
  1. 10 core/lib/Drupal/Core/Field/Attribute/FieldFormatter.php \Drupal\Core\Field\Attribute\FieldFormatter
Same name in other branches
  1. 9 core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php \Drupal\Core\Field\Annotation\FieldFormatter
  2. 8.9.x core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php \Drupal\Core\Field\Annotation\FieldFormatter
  3. 11.x core/lib/Drupal/Core/Field/Attribute/FieldFormatter.php \Drupal\Core\Field\Attribute\FieldFormatter
  4. 11.x core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php \Drupal\Core\Field\Annotation\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

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 = [];
    
    /**
     * An integer to determine the weight of this formatter.
     *
     * Weight is relative to other formatter in the Field UI when selecting a
     * formatter for a given field instance.
     *
     * This property is optional and it does not need to be declared.
     *
     * @var int
     */
    public $weight = NULL;

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
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 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
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. 3

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