Contrib.social

Pass field entity context into the field plugin build

Open on Drupal.org →
Created on 6 December 2023, 7 months ago
Updated 9 April 2024, 3 months ago

ExtraFieldTypePlugins do not have the context of their parent EntityExtraField entity. This is a problem specifically with the block plugin, which expects a unique ID passed into the #id value. That ID gets used for both the HTML ID of the block as well as the theme template suggestions available to themers. Currently in the block plugin, the #id gets set to str_replace(':', '-', $block->getPluginId()) and the hypen in the string replacement throws an error (seen in the template suggestions HTML comment). If the plugins had the field entity context, we could appropriately set the ID to the value typed in by the site builder, same as the default blocks work: '#id' => $field_entity->name(). Passing this value in would be easy enough. EntityExtraField.php on line 330 could be something like this: 'content' => $field_type_plugin->build($entity, $display, $this). This would pass in the entity for context, and then display plugins could leverage that as needed.

🐛 Bug report
Status

Postponed: needs info

Version

2.0

Component

Code

Created by

🇺🇸United States jnettik Denver, CO

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @jnettik
  • First commit to issue fork.
  • Status changed to Needs review 5 months ago
  • Comment 5 months ago →
    🇺🇸United States COBadger
  • Comment 3 months ago →
    🇺🇸United States droath

    @jnettik

    I have made the changes as outlined so that any entity extra field plugin type can utilize the data attached to the extra field object. I am concerned that this patch might cause issues for existing sites that rely on the block ID instead of using the entity field name. Are you willing to test this patch to ensure it works for your problem?

  • Status changed to Postponed: needs info 3 months ago
  • Comment 3 months ago →
    🇺🇸United States droath
contrib.social Blog FAQ Discussions
Production build 0.69.0 2024