Fatal error in appendItem() method signature on Drupal 10

Created on 27 November 2024, 4 months ago

Problem/Motivation

When using the EntityQueue module with Drupal 10.3.10, the following fatal error occurs:

Fatal error: Declaration of Drupal\entityqueue\EntitySubqueueItemsFieldItemList::appendItem($value = null) must be compatible with Drupal\Core\Field\FieldItemList::appendItem($value = null, $notify = true) in /path/to/web/modules/contrib/entityqueue/src/EntitySubqueueItemsFieldItemList.php on line 15

This error happens because the method signature of appendItem() in EntitySubqueueItemsFieldItemList does not match the updated signature in Drupal core's FieldItemList.

Steps to reproduce

Install Drupal 10.x (e.g., 10.3.10).
Install the EntityQueue module (8.x-1.x).
Use code that invokes $subqueue->get('items')->getValue();.
Observe the fatal error mentioned above.

Proposed resolution

Update the appendItem() method signature in EntitySubqueueItemsFieldItemList.php to match the parent class in Drupal core by adding the $notify parameter:

public function appendItem($value = null, $notify = true) {

Remaining tasks

Review the patch.
Test the patch in a Drupal 10 environment.
Commit the fix to the module.

User interface changes

This fatal error prevents the module from functioning in Drupal 10, affecting any site using EntityQueue and attempting to call appendItem().

API changes

Data model changes

🐛 Bug report

Status

Active

Version

1.8

Component

Code

Created by

🇺🇸United States mpifalo

Live updates comments and jobs are added and updated live.

Comments & Activities

Issue created by @mpifalo
Comment 4 months ago →
🇺🇸United States mpifalo
More info: we can trigger the error with custom code in our theme $items = $subqueue->get('items')->getValue();.

Created a patch locally and am testing up in our dev environment; if it works well I can try to do a merge request if no one else has done so yet.
Comment 4 months ago →
🇺🇸United States mpifalo
Actually, this issue is caused by a patch we added for core: https://www.drupal.org/project/drupal/issues/2988123 🐛 Appending/removing a field item to a field item list doesn't notify the parent of the change Needs work . So this is not anything to do with EntityQueue. Will mark as closed/won't fix - sorry for the noise.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024