Extra Field Plus - Extra Field Settings Provider

🇺🇦

TL;DR

Extra Field Plus provides interfaces and plugin classes to create pseudo-fields (like extra_field) with editable display settings (addition by this module).
This is a developer module.

Problem solved

This module helps to create display-only 'extra_field' fields from plugins, including settings and settings summary, instead of using hook_entity_extra_field_info and reinventing the wheel again and again.

What is an extra_field (pseudo-fields)?

Pseudo-fields are basic display fields, which can be controlled from the display settings of a specific entity type (bundle). They are usually used, when you want to render data together with a particular entity type's data, but do not want to hard-code that data inside a template or preprocessor.

How to use

To provide your custom extra field plugin with display settings, you must at least implement the ExtraFieldPlusDisplayInterface.

But there are two base plugin classes which can help you with implementing your extra field settings plugin.
Just let your extra field settings plugin class extend either ExtraFieldPlusDisplayBase or ExtraFieldPlusDisplayFormattedBase.

All your extra field settings plugins have to be placed in your_custom_module/src/Plugin/ExtraField/Display folder.

Examples

For basic examples for extra field settings plugin classes, with simple and formatted outputs, checkout the extra_field_plus_example submodule.
You can find the examples here in the GitLab repository.

Dependencies

• Extra Field

Versions

• 3.x is the successor of 8.x-2.x with clean-ups, Layout Builder support and additional features like settings summary. New features go into this 3.x!
• 8.x-2.x is the recommended and stable version. Bug fixes only, no new features. No layout builder support.

Alternatives

• https://www.drupal.org/project/entity_extra_field

BC: Upgrading from 8.x-2.x to 3.x

When upgrading from 8.x-2.x to 3.x see the UPGRADE.md as breaking changes require you to upgrade your extra field plugins!