Profile picture for user admin
Daniel Sipos
02 Jun 2015

In this article we are going to look at how we can create and use pseudo-fields in Drupal 8.

What are pseudo-fields?

Pseudo-fields are simple display fields that you can control from the display settings of a particular entity type. An example of such a field is the core Links field on the node or comment entities.

Why are they useful?

Pseudo-fields are great if you have some content or data that you need to render together with that of a particular entity. And since you don't want to be hacky and hardcode all of this inside a template or preprocessor, you can use pseudo-fields to expose some control over this to the UI. This means that you can use the core drag-and-drop functionality to control their visibility and position relative to regular entity fields.

Pseudo-fields are a great way to display data that is tightly coupled to the entities but is not part of them or their fields.

So how do they work?

There are 2 main steps we need to take in order to create a pseudo-field. First, we need to implement hook_entity_extra_field_info() which is similar to Drupal 7.

 * Implements hook_entity_extra_field_info().
function my_module_entity_extra_field_info() {
  $extra = [];

  foreach (NodeType::loadMultiple() as $bundle) {
    $extra['node'][$bundle->Id()]['display']['my_own_pseudo_field'] = [
      'label' => t('My own field'),
      'description' => t('This is my own pseudo-field'),
      'weight' => 100,
      'visible' => TRUE,

  return $extra;

We mustn't forget to use the NodeType class at the top of the file:

use Drupal\node\Entity\NodeType;

With this implementation we are creating one pseudo-field called My own field that will show up on the display settings of all the node bundles. After clearing the cache, you can already see it if you go to the display settings of any node bundle you have.

drupal 8 pseudo fields

The second step is making this field actually render something when the node is being viewed. For this we need to implement hook_entity_view() or any of its variants:

 * Implements hook_ENTITY_TYPE_view().
function my_module_node_view(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode) {
  if ($display->getComponent('my_own_pseudo_field')) {
     $build['my_own_pseudo_field'] = [
        '#type' => 'markup',
        '#markup' => 'This is my custom content', 

And again, let's use the necessary classes at the top:

use \Drupal\Core\Entity\EntityInterface;
use \Drupal\Core\Entity\Display\EntityViewDisplayInterface;

Above we went with the hook_ENTITY_TYPE_view() variant that applies to the node entity. Inside, we are being passed an EntityViewDisplayInterface display object which we can use to check whether or not our own component (the one we defined earlier) exists in this display. If it does, we add our custom data to the $build render array that is passed by reference. This check allows the user interface to determine the visibility of this component on each view mode, as well as the weight (position relative to the other components which can be either entity fields or other such pseudo-fields).

And that's about it. You can save, edit the display settings of your nodes, create view modes and specify exactly for which one and where this custom content should show up.

Hope this helps.

Profile picture for user admin

Daniel Sipos

CEO @ Web Omelette

Danny founded WEBOMELETTE in 2012 as a passion project, mostly writing about Drupal problems he faced day to day, as well as about new technologies and things that he thought other developers would find useful. Now he now manages a team of developers and designers, delivering quality products that make businesses successful.

Contact us


David M 05 Jun 2015 22:54

Drupal 7 equivalent to hook_entity_extra_field_info()

Good article! In the first paragraph under the section labeled 'How do they work?' you alluded to a Drupal 7 equivalent, but did not name it:

There are 2 main steps we need to take in order to create a pseudo-field. First, we need to implement hook_entity_extra_field_info() which is similar to Drupal 7.

I believe that you were referring to the Drupal 7 hook function hook_field_extra_fields()

Manuel García 01 Jul 2015 11:46

pseudo-fields formatter?

Great article!

Would it be possible to add a formatter?
I'm trying to make one but does not work with this type of fields.


Dezső BICZÓ 26 Nov 2015 15:56

Link should be fixed


The "hook_entity_extra_field_info()" link above, in the "So how do they work?" paragraph, should link to the API page instead of this article I think.
(I could not paste the link here, because the spam filter on your site.)

Insasse 05 Sep 2016 15:02

Thanks for the guidance.

So there I have a pseudo field.
But how to use it?
How give it some value .... ?

Alex 11 Nov 2016 12:43

Settings for pseudo fields

Hey, do you know if it is possible to add settings(like a field formatter settings) for a pseudo field?

dom18fr 17 Nov 2016 12:42

In reply to by Alex (not verified)

No settings for pseudo fields

There is no way to add a field formatter or setting for a pseudo field. The purpose of a field formatter is to get values from the db and produce a render array with it. Since a pseudo field do not store anything in the db, you have to build the render array directly from your hook_entity_view implementaion. However, you can manage a configuration related to this process and provide a form for it anywhere you want in a admin page, but there's no way to add it automatically in the field ui like field formatter settings does.

There an alternative way to achieve this, you can create a custom field type that actually do not store anything in db. Then you create a field formatter for it, so can manage settings here.

Adrian Cid Almaguer 23 Feb 2017 00:29

Can we have a label?

Can we have the option to show or hide the label of the field?

And the 5th param




I think that is not more used, see the docs (note: I don't know why I can't write here the url)

Sutharsan 22 Apr 2017 20:27

A module for Pseudo fields

To make it easy for developers to create a Pseudo field, I have made Extra Field module. Developers can create extra fields by only creating a single plugin. Example plugins are provided.

Danny, thanks for the inspiration.

Regnoy 18 May 2017 15:16


Pseudo field vs Display Suite
What is the better in productivity, performance and speed?

Samrat 31 Aug 2017 14:47

pseudo field per node

Hi Danny,

I have created a pseudo field taking inspiration from your code. Now how can a create a simple checkbox setting while creating a node to show/hide pseudo field per node?


Barrett Langton 08 Nov 2017 17:03

Nice article!

I had done this before in D7, and was wondering how to accomplish it in D8. I was thinking it was going to be more complex, but pretty similar to D7. Thanks!

Thomas 19 Jan 2018 19:35

Theme this pseudo field like a normal field

Great article and really great book!
How can this field be themed like a normal field using field.html.twig? I don't want to include too much HTML in the markup, and would like to have it themed like a normal one.

Nicky Aiuto 12 Aug 2022 23:34

In reply to by Thomas (not verified)

Theming extra field

Using the extra_field module as a guide I was able to make a simple field that displays the entity's bundle. Use hook_entity_extra_field_info as described above. Then in hook_entity_view or equivalent create a render array like this:

$build['field_content_type'] = [
'#theme'=> 'field',
'#title' => 'Content type', // your choice of field label here
'#label_display' => 'inline',
// I gleaned these bits from ExtraFieldDispayFormattedBase
// Prevent quickedit from editing this field by using a special view mode.
// @see quickedit_preprocess_field()
'#view_mode' => '_custom',
// Only keys in "#items" are required in template_preprocess_field().
'#items' => [0 => new \stdClass()],
0 => ['#markup' => $entity->type->entity->label()], // your value here

This is the barest render array I could create to get my result. You can do more with the other properties that the field theme examines.

Thank you Daniel for all your articles. You've been very helpful to me over many years.

Tolga Özses 12 Jun 2018 00:33

Create a button

Is it possible to create a button with this approach?

Claudiu 30 Aug 2018 12:45

How about EntityFormDisplay ?

Nice article.
I have a question though: how about adding a custom field (pseudo-field) to an EntityForm ?
I now how to define it in hook_entity_extra_field_info() but I haven't figure out where to manage it ?

Thanks in advance.

Lex 29 Dec 2018 01:24

Drupal way

Use module and examples and compare

Iyyappan 29 Dec 2019 05:57

How to enable label options

Hi, Thanks for the post. Is there any way to add the label options for pseudo fields? Thanks

Add new comment