Drupal 8, get programmatically the list of fields of a custom content

Question

I want create programmatically a custom content (custom content created via the admin UI). But, before the creation, I want check programmatically the types of fields of my custom content

My custom content contains a field "body" (type text), a field "description" (type text), an int field (type int), an attached file field (type fid ?)...

I test several ways with the new api of Drupal 8, my last try..

// I get the entity object "my_custom_content"
$entity_object = NodeType::load("my_custom_content");
dpm($entity_object); //Work perfectly


$test = \Drupal::getContainer()->get("entity_field.manager")->getFieldDefinitions("my_custom_content",$entity_object->bundle())
//The \Drupal::getConta... Return an error : The "my_custom_content" entity type does not exist.

With this $entity_object, how can I get the list of the fields of my custom content ? I see the EntityFieldManager Class, the FieldItemList Class...But I still do not understand how to play with drupal 8 / class / poo ... :/

Thanks !

Eyal · Accepted Answer · 2017-07-19T12:09:33.327

12

NodeType is the (config) bundle entity for the Node (content) entity.

The correct call would be:

\Drupal::service('entity_field.manager')->getFieldDefinitions('node', 'my_custom_content');

To get the field definitions of any entity_type use the following structure:

\Drupal::service('entity_field.manager')->getFieldDefinitions(ENTITY_TYPE_ID, BUNDLE_ID);

For example, if you want to get all the field definitions of a paragraph bundle with the id multy_purpose_link then replace ENTITY_TYPE_ID with paragraph and BUNDLE_ID with multy_purpose_link

\Drupal::service('entity_field.manager')->getFieldDefinitions('paragraph', 'multy_purpose_link');

edited Jul 19 '17 at 12:09

answered Nov 28 '15 at 02:54

Eyal

758
6
23

Working fine with node content type, but not work with "Paragarph" entity type. – Rajesh Vishwakarma Jul 19 '17 at 11:05
$fields = \Drupal::service('entity_field.manager')->getFieldDefinitions('paragraphs_type', 'paragraphs_name'); – Rajesh Vishwakarma Jul 19 '17 at 11:59
Updated the answer with a more general explanation. – Eyal Jul 19 '17 at 12:10
To get the field names, you can use `array_keys()` on a result from this answer, e.g. `$fieldNames = array_keys($fieldDefinitions);`. – tyler.frankenstein Jun 30 '20 at 00:12

score 3 · Answer 2 · answered Sep 20 '17 at 10:36

3

The given answers are deprecated. You should now load the entity and just use getFieldDefinitions() to fetch the field definitions.

$node = Node::load($slide_id);
$field_defs = $node->getFieldDefinitions();

answered Sep 20 '17 at 10:36

Bram

2,515
6
36
58

score 1 · Answer 3 · answered May 19 '17 at 11:13

1

Or

$field_defs = \Drupal::service('entity_field.manager')->getFieldDefinitions('taxonomy_term', '<taxonomy machine name here>');

If you want to get the list of field_definitions for a taxonomy vocabulary

answered May 19 '17 at 11:13

Bernhard Zürn

584
6
11

score 1 · Answer 4 · edited Sep 01 '21 at 06:25

1

If the entity type does not have a bundle, for example the user entity.

Try this:

 // All user fields and ones added 
 $user_fields = \Drupal::service('entity_field.manager')->getFieldDefinitions('user','user'); 

// Just default 
$default_user_fields  = \Drupal::service('entity_field.manager')->getFieldDefinitions('user', NULL);

edited Sep 01 '21 at 06:25

Gagik

169
2
11

answered Nov 27 '19 at 23:36

taggartJ

277
2
6

Thanks @Taggart Jensen. I was searching the bundle to use for custom user fields. This was the perfect answer. – Marshall Morrise Apr 25 '20 at 20:21

Drupal 8, get programmatically the list of fields of a custom content

4 Answers4