getEntitiesToView() should implements the same interface as viewElements()

I've tested the patch in #3 and (shockingly) it applies cleanly to Drupal core 9.2.9. We experienced the error above (TypeError: Argument 1 passed to...) when indexing content with search_api_solr. I'm still digging into the root cause, but applying the patch resolved our issue.

I'm changing the version to 9.4.x to see if this tests well there. Unfortunately my reproduction steps are relatively complex. I was able to recreate the error with the Open Y Virtual YMCA Search module from version 1.6 of https://github.com/ymcatwincities/openy_gated_content.

Approving that patch #3 fixes the issue

+1 RTBC
Works well for us on 9.3.9 core, PHP 8.1.4

The issue summary begins with 'The next plugins' as if this is a follow up to some other work. Is it? If that is the case, please add the reference. From my reading of the issue is it not clear that this is reproducible with just Drupal core. Can anyone provide steps to reproduce? Adding tags.

I then searched and found #3138527: getEntitiesToView() should implements the same interface as viewElements() which has the same patch as this but with a different list of plugins in the Issue Summary. If this suggested fix here is relevant to more plugin/situations that should be discussed here. I am closing the other issue as a duplicate of this one and noting the plugins here:

• Drupal\user\Plugin\Field\FieldFormatter\AuthorFormatter
• Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceLabelFormatter
• Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceEntityFormatter
• Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceIdFormatter
• Drupal\taxonomy\Plugin\Field\FieldFormatter\EntityReferenceTaxonomyTermRssFormatter

.

Cheers.

perhaps helpful as a step to reproduce. I am seeing a warning in PHPStorm with phpcs enabled with standard "Drupal" (see attached). There is a similar file attached to this ticket from the reporter. Patch #3 fixes the warning.

This change seems to have upstream consequences as well. I ran into an issue with a Webforms Entity Reference field throwing this error:

Fatal error: Declaration of Drupal\webform\Plugin\Field\FieldFormatter\WebformEntityReferenceFormatterBase::getEntitiesToView(Drupal\Core\Field\EntityReferenceFieldItemListInterface $items, $langcode) must be compatible with Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase::getEntitiesToView(Drupal\Core\Field\FieldItemListInterface $items, $langcode) in /var/www/modules/contrib/webform/src/Plugin/Field/FieldFormatter/WebformEntityReferenceFormatterBase.php on line 60

and that seems to be a result of this patch. A GitLab search reveals almost 100 other calls which would have to be updated as a result of this change.

So... unless this is going to be a breaking change we might want to rethink the solution.

@quietone regarding "The next plugins" I think that might just be a gap in translation. I'm guessing @tao meant "the following plugins"

Here's a list of all of the possibly affected plugins in Core.

I'm not sure of the best way to recreate the issue, but as @scott_earnest mentioned, there seems to be a mismatch here.

in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceFormatterBase.php

protected function getEntitiesToView(EntityReferenceFieldItemListInterface $items, $langcode) {

but then in the plugins (this from core/modules/file/src/Plugin/Field/FieldFormatter/UrlPlainFormatter.php)

public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];

    foreach ($this->getEntitiesToView($items, $langcode) as $delta => $file) {

Sorry that's a lot... but it's all to say... I think this is "needs work", but I'm not sure what work exactly. :D

+1 RTBC #3 on Drupal core 9.4.x

I've made a change in our contributed module that I'm hoping will resolve this issue instead of needing the core patch.

Based on #2878691: Error: Recoverable fatal error: Argument 1 passed to Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase::getEntitiesToView I'm hoping this is a case of misleading error messages and we'll be able to resolve it when similar situations arise, although that doesn't explain the issue raised in #10.