Contrib.social

Media library widget not working with Layout paragraphs

Open on Drupal.org →
Created on 7 March 2025, about 2 months ago

Problem/Motivation

First of all, thank you for the work on that module, which is absolutely great.

I'm not sure if the issue belongs to that module's queue or to layout paragraphs one, but I'm facing an issue with custom field in a paragraph using Media entity reference and Media library widget.

Basically adding a media (in the custom field) in the paragraph through layout_paragraphs widget works. When I save the paragraph, I see my media. But If I re-open the paragraph edit form, the Media library widget is empty (actually the media reference id is NULL).

Apparently the issue is located in the MediaLibraryWidget.php file from the line 187 to 199 : 

     if (!empty($parents)) {
        // Look for the value again if the field is in a closed subform.
        $id = $item->{$sub_field_name};
        $field_path = array_merge($parents, [$field_name, $delta, $sub_field_name]);
      }
      else {
        $field_path = [$field_name, $delta, $sub_field_name];
      }
      if ($selection = NestedArray::getValue($input, $field_path)) {
        $target_id = $selection['selection'][0]['target_id'] ?? NULL;
        $selected_id = $selection['media_library_selection'] ?? NULL;
        $id = $target_id ?? $selected_id;
      }

Apparently the $parents is empty and so as the $input, leading to an empty $reference_entity.

Steps to reproduce

  1. Create a paragraph type
  2. Create on that paragraph type a custom field with a field "Entity_reference > Media" and set the "Media library" widget.
  3. Create a content type and add an "Entity reference revisions" field to reference the previously created paragraph type.
  4. Then on that "Entity reference revisions" field, set the form widget to "Layout paragraphs".
  5. Now add a new content by adding a new paragraph instance and add a media and save the content.
  6. Go back to the edit page of the content and edit the paragraph you have just created. The media library widget empty.

Proposed resolution

I managed to make the code works by changing the lines : 

 if (!empty($parents)) {
   // Look for the value again if the field is in a closed subform.
   $id = $item->{$sub_field_name};
   $field_path = array_merge($parents, [$field_name, $delta, $sub_field_name]);
}
else {
  $field_path = [$field_name, $delta, $sub_field_name];
}

By : 

  $id = $item->{$sub_field_name};
  $field_path = array_merge($parents, [$field_name, $delta, $sub_field_name]);

though, if not sure if it's a correct solution to be addressed to that module, or if I should open an issue on Layout_paragraphs' queue (if the missing $parents is caused by that module).

🐛 Bug report
Status

Active

Version

3.1

Component

Code

Created by

🇨🇭Switzerland grumpy74 Geneva, CH 🇨🇭

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

Comments & Activities

  • Issue created by @grumpy74
  • Comment about 2 months ago →
    🇨🇭Switzerland grumpy74 Geneva, CH 🇨🇭
  • Comment about 2 months ago →
    🇺🇸United States apmsooner

    I honestly havn't used layout_paragraphs and therefore didn't have a chance to test this scenario. I will try to find time to test it and reproduce the issue but it also looks like theres a good number of issues with their module with at least a few related to media so really hard to say where the issue lives. I do know that in normal paragraphs, the media library widget has been working as expected. Layout paragraphs must be doing something a little differently perhaps.

  • Comment about 2 months ago →
    🇨🇭Switzerland grumpy74 Geneva, CH 🇨🇭

    Thanks for the feedback. I’ll try to find a moment to check if I can dig into that specific case. Otherwise I’ll create a custom field widget to handle that specifically case instead of trying to tweak the generic one. Like so said it seems to be linked on the way layout paragraphs deals with subforms.

    Than you again for the amazing job on custom_field.

    Regards

  • Comment about 2 months ago →
    🇺🇸United States apmsooner

    Thanks for the encouragement and happy the module is found useful! Good interim idea for your own custom widget. The documentation is here for doing that: https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib... →

  • Comment about 2 months ago →
    🇨🇭Switzerland grumpy74 Geneva, CH 🇨🇭

    Thank you @apmsooner, I actually duplicated the MediaLibrary widget to create my own (extending the original one) and only override the "widget" method to make it work the same way as in the MR opened in that ticket, just in case others need that feature.

    Considerate that, I thing the issue can be closed as the issue is definitely on the layout paragraphs side (which is not dealing with subforms the regular way therefore the #parents key of the form is empty). I'll maybe open an issue in their tracker and see...

    Again thanks for providing the widget documentation link and to make custom_field formatters/widgets that easy to create.

  • Comment about 1 month ago →
    🇺🇸United States apmsooner
contrib.social Blog FAQ Discussions
Production build 0.71.5 2024