[upstream] Entities with no custom viewmodes cannot be embedded as "Rendered entity"

I think a better example might actually be entities that don't really use the view mode system, like config entities that can be viewed. Core does that for blocks, but that's actually a tricky example as access checking there might result in unexpected behavior as it considers visibility conditions. Contrib might have other examples though, for example our sharemessage project.

We could fall back to the default rendered entity case if there are no view modes. The problematic part is that creating a view mode would then result in different options being available.

I think all entities should have a pre-set for Default view modes. or the Default view mode in the Field Display should copy the Form Display if it ware not configured by the site builder.

At least, we should improve the description here and indicate that it is possible to show the rendered entity, but before being able to select that, they need to:
1) create a custom viewmode
2) activate it on the entity's display
3) clear the caches
and only then this option will be available on the button creation form.

I can create custom view modes for nodes; if it is possible to do this for system blocks (for example the "powered by" block) as well, in code for example, I can't figure out how. If someone can point me in the right direction, I'll try to document this.

Thanks!

I was having issues with embedding Media entities until I came across this Issue. I was able to create a work around after learning that I needed to create a view and use that to display the entity in the WYSIWYG.

My related question: Would it be possible (or easier) to define a view display when creating the Entity Embed button for the WYSIWYG? If it was possible to do that, then the developers could only check the "View" checkbox and select the appropriate view display.

Content authors would not need to select the appropriate view display when adding media entities. It would be great if we could also pre-check the View Arguments in the button setup.

Just a thought - great module otherwise. This has been a very helpful module in my project!

The ideal solution would be to use the "default" viewmode and present it as an option labelled something like "Render the entity using the default viewmode"

I think this makes sense.

This is also what Views does in \Drupal\views\Plugin\views\row\EntityRow::buildOptionsForm():

  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);

    $form['view_mode'] = [
      '#type' => 'select',
      '#options' => \Drupal::entityManager()->getViewModeOptions($this->entityTypeId),
      '#title' => $this->t('View mode'),
      '#default_value' => $this->options['view_mode'],
    ];
  }

That ends up calling \Drupal\Core\Entity\EntityDisplayRepository::getDisplayModeOptions(), which does:

  protected function getDisplayModeOptions($display_type, $entity_type_id) {
    $options = ['default' => t('Default')];
    foreach ($this->getDisplayModesByEntityType($display_type, $entity_type_id) as $mode => $settings) {
      $options[$mode] = $settings['label'];
    }
    return $options;
  }

IOW: this is just plainly a bug in Entity Embed; it's not using the correct API.

Actually, \Drupal\entity_embed\Plugin\Derivative\ViewModeDeriver::getDerivativeDefinitions() is calling \Drupal\Core\Entity\EntityDisplayRepositoryInterface::getAllViewModes(), which does:

  public function getAllViewModes() {
    return $this->getAllDisplayModesByEntityType('view_mode');
  }

  protected function getAllDisplayModesByEntityType($display_type) {
    if (!isset($this->displayModeInfo[$display_type])) {
      $key = 'entity_' . $display_type . '_info';
      $entity_type_id = 'entity_' . $display_type;
      $langcode = $this->languageManager->getCurrentLanguage(LanguageInterface::TYPE_INTERFACE)->getId();
      if ($cache = $this->cacheGet("$key:$langcode")) {
        $this->displayModeInfo[$display_type] = $cache->data;
      }
      else {
        $this->displayModeInfo[$display_type] = [];
        foreach ($this->entityTypeManager->getStorage($entity_type_id)->loadMultiple() as $display_mode) {
          list($display_mode_entity_type, $display_mode_name) = explode('.', $display_mode->id(), 2);
          $this->displayModeInfo[$display_type][$display_mode_entity_type][$display_mode_name] = $display_mode->toArray();
        }
        $this->moduleHandler->alter($key, $this->displayModeInfo[$display_type]);
        $this->cacheSet("$key:$langcode", $this->displayModeInfo[$display_type], CacheBackendInterface::CACHE_PERMANENT, ['entity_types', 'entity_field_info']);
      }
    }

    return $this->displayModeInfo[$display_type];
  }

Note how that does not have the default logic like the code quoted at the bottom of my previous comment.

This seems like it's simply a bug in \Drupal\Core\Entity\EntityDisplayRepository!

> This seems like it's simply a bug in \Drupal\Core\Entity\EntityDisplayRepository!

Yes, EntityDisplayRepository is definitely inconsistent, but IMHO, it's wrong in the opposite direction. default should not be an option you can select.

#2844203: Improve/Simplify situation around Default/Full view modes/view displays, where you commented as well. but as commented there, I have no idea how that could be done in a non-BC breaking way, which means it can *not* be done as 9.0 must be compatible with 8.latest.

Hah! 😂😭

I think a better example might actually be entities that don't really use the view mode system, like config entities that can be viewed.

#3046480: Re-enable 'Rendered entity' formatter derivative for configuration entities just fixed that, which is probably the most common scenario.

Can we close this, or should this still happen?

🥳

There should absolutely be either a "default" option, or unchecked "Allowed Entity Embed Display plugins" should be ignored completely while embedding.

"If none are selected, all are allowed." which imo doesn't make sense here, hence the disclaimer "Note that these are the plugins which are allowed for this entity type, all of these might not be available for the selected entity."

This puts entities without a custom display mode (only the "default" display) in the awkward situation where they have to create a display mode for the embed button to make sense. I.e. it's extra work and config.

Not to mention we can't create a view mode called "default" because it's reserved.