Consider adding a hook to Paragraphs::getSummary

I have created a patch where the getSummary dispatches two different events :

ParagraphSummaryExcludeFieldsEvent
Dispatched in the beginning of getSummary, subscribers can add fields excluded from the summary

ParagraphSummaryAlterEvent
Dispatched after data is collected from the fields, subscriber can prepend/append strings to the summary array

The subscriber could do something like this:

/**
 * @file
 * Contains \Drupal\mymodule\ModuleEventSubscriber.
 */
namespace Drupal\mymodule\EventSubscriber;
use Drupal\paragraphs\Event\ParagraphSummaryAlterEvent;
use Drupal\paragraphs\Event\ParagraphSummaryExcludeFieldsEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Class ModuleEventSubscriber.
 *
 * @package Drupal\mymodule
 */
class ModuleEventSubscriber implements EventSubscriberInterface {
  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events[ParagraphSummaryAlterEvent::ALTER][] = array('onAlterSummary', 800);
    $events[ParagraphSummaryExcludeFieldsEvent::EXCLUDEFIELDS][] = array('onExcludeFields', 800);
    return $events;
  }

  /**
   * Subscriber Callback for the event.
   * @param ParagraphSummaryAlterEvent $event
   */
  public function onAlterSummary(ParagraphSummaryAlterEvent $event) {
    $event->prependTextToSummary('#' . $event->getParagraph()->Id());
   }

   /**
   * Subscriber Callback for the event.
   * @param ParagraphSummaryExcludeFieldsEvent $event
   */
  public function onExcludeFields(ParagraphSummaryExcludeFieldsEvent $event) {
    $event->excludeFields(['field_button_color', 'field_button_text']);
  }
}

NB: there are some uncommented code for list_string fields.
Currently only the first value (not the label) are being outputted.
I will work on some code so all labels are outputted.

Needs reroll, summary method is changed from #2852001: Consider container multivalue children for closed summary

Different approach with the alter hook.

IMHO this doesn't help too much.

We are updating here the summary that then is concatenated.

We have other issues that will extend the summary with two icon areas per summary. Those icons should be similarly alterable by the hook. The collapsed plain text summary is just one summary component.

See also newly related task.

Patch rerolled

Rerolled #7 to keep the ball rolling. Why should this be event driven? Sorry if it's an ignorant question, but I don't see why this shouldn't just be an alter

I think the alter hook would be a lot more useful if the $summary array was keyed by field id. As it is now we can add summaries, but it doesn't give us an easy way to selectively strip certain fields.

Additionally, having the $options array that is passed to the getSummary method would be useful. It would allow any additions to respect the options.

That's definitely true but also challenging, considering that we generate the summary recursively in some cases. We'd need to either switch to a nested structure or introduce a solution for having unique flat keys. Not sure yet.

After working with this over the weekend, I'd definitely vote for the nested structure. I was simplifying/adjusting output to be more user-friendly for editors and it would have made parts of it a lot easier. The order of fields is particularly an issue.

Additionally, the forced implode(',', $summary) just didn't work for what I was trying to do. I eventually had to combine everything the way I wanted and inserted it as a single entry returned by the hook to avoid that. It got me thinking that there should probably be a new template for summaries, and the implode behavior could be handled there.

The patch provided in #19 doesn't fire the exclude fields event.
I've fixed this and also a few coding standard issues.

Here's the patch :D

The internal structure of the summary is still in flux and evolving, we've now changed it to an array of content and behavior items, so we're a step closer. But to make any sense of it being alterable, we also need named keys and a stable structure.

People who used this patch might also want to check if the new summary template and corresponding preprocess helps them do what they want to do.

Yeah, we should put those keys asap.

What could still add one last(?) change in the summary structure is #2932406: Display field image thumbnail in the paragraph summary

Promoting this to major so we will look into it when we review the Roadmap. :-)

New approach, calls the alter inside the loop and passes field name and field type, so implementing a subscriber will be easier

Example subscriber https://www.drupal.org/project/viewsreference/issues/3137849#comment-136...

Better event name

Alter also means completely changing the summary, currently there aren't any way to remove the existing summary data and replace it with something else. Lets add that also..

Comparing patch 28 vs patch 29, we seem to have lost the actual trigger for the fields exclusion event.

Patch #33 seems to work and include the needed functionalities.

Just tested this on my project and worked without issues.
Tested against 8.x-1.12.

Patch in #33 seems to work for me against 8.x-1.13.

My use case is to give more information around a "From Library" paragraph. For now just prepending the Paragraph bundle of the item in the Library.

I wonder why the summary is only limited to content in patch #33, there is also behaviors and maybe potentially more array properties of summary. I think it is better to allow modifying the summary array completely if needed, this is the main purpose of alter.

Here is modified patch to allow alterations to any parts of summary

Both patches (#38 and #33) work for me on my project. +1 RTBC

I believe these patches fail in Drupal 10 sites with the error:

Uncaught Error: Class "Symfony\Component\EventDispatcher\Event" not found in modules/contrib/paragraphs/src/Event/ParagraphSummaryAlterEvent.php:4

According to vendor/symfony/event-dispatcher/CHANGELOG.md, in Symfony 5.x
The `Event` class has been removed in favor of `Symfony\Contracts\EventDispatcher\Event`.

Based on this I think the use statement at the top of src/Event/ParagraphSummaryAlterEvent.php should be updated
from
use Symfony\Component\EventDispatcher\Event;
to
use Symfony\Contracts\EventDispatcher\Event;

for sites that are based on Symfony 5 or above.

@vladigor@gmail.com In patch #38 this class is not used. It uses the class Drupal\Component\EventDispatcher\Event according to change record: https://www.drupal.org/node/3159012

Thanks @a.dmitriiev.
I've switched over to patch #38 on my Drupal 10.1.0 site using Paragraphs 1.15.0.
When I try to edit a page that contains paragraphs I get the following error:

TypeError: Drupal\Component\EventDispatcher\ContainerAwareEventDispatcher::dispatch(): Argument #1 ($event) must be of type object, string given, called in /app/docroot/modules/contrib/paragraphs/src/Entity/Paragraph.php on line 468 in Drupal\Component\EventDispatcher\ContainerAwareEventDispatcher->dispatch() (line 89 of core/lib/Drupal/Component/EventDispatcher/ContainerAwareEventDispatcher.php).

It appears that in Drupal 10.1 the event_dispatcher service uses the dispatch function from ContainerAwareEventDispatcher.php, which expects $event as the first parameter.
Ref. https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Component%21Even...

I've attached an updated version of patch #38 that switches around the parameters in the two calls to the dispatch function.

Changing the status to needs review for now. Seems wrong to keep it on RTBC.

#42 is working for me with Drupal 10.1.5 and Paragraphs 8.x-1.16

#42 is working for me as well for Drupal 10

Re-rolled #42 patch to check for empty of summary[$type] on appendTextToSummary() and prependTextToSummary() in src/Event/ParagraphSummaryAlterEvent.php

Re-rolled #46 for 1.19.

I have opened MR based on patch #47 for easier review process and maybe it will speed up the merge of the changes.

The MR had missing code from the patch, I pushed it.
I attached a patch file for composer patching against 1.19 version.

confirming that the pacth #51 and MR work on:

• Drupal: 10.4.5
• Paragraphs: 1.19.0

In our case we use a ParagraphSummarySubscriber to alter paragraphs summary based on custom conditions, which works as expected using ParagraphSummaryAlterEvent

I can confirm the merge-request code works fine in Drupal 10.4.6.

I am just confused about adding isEmpty for append and prepend methods from #46. I don't see the benefit in having to check the summary in my own code before using appending/prepending.

I don't want to just change it without getting another feedback on this opinion.

Adding a re-rolled patch for V8.x-1.19

Here's the patch

One more try with the right filenam

This is a re-roll for V8.x-1.19

Re-rolled patch for V8.x-1.20