WidgetBase::extractFormValues relies on non guaranteed return value

Created on 30 December 2016, over 7 years ago

Updated 9 January 2024, 6 months ago

\Drupal\Core\Field\WidgetBase::extractFormValues expects $value to be an array, although this is not guaranteed.

This is the affected part:

    // Extract the values from $form_state->getValues().
    $path = array_merge($form['#parents'], array($field_name));
    $key_exists = NULL;
    $values = NestedArray::getValue($form_state->getValues(), $path, $key_exists);
    if ($key_exists) {
..
      // Let the widget massage the submitted values.
      $values = $this->massageFormValues($values, $form, $form_state);

There are cases (as described in the method summary of NestedArray::getValue) in which it returns null but $key_exists is true. Then we get an fatal error, because WidgetBase::massageFormValues receives null as $values.

In this case we have 2 possibilities:

* NestedArray::getValue sets key_exists to false if the return value is null
* WidgetBase::massageFormValues checks not just key_exists but also the expected type

The first possibility conflicts to the method summary of NestedArray::getValue, wherefore I created a patch for the second possibility.

In my patch I also addressed the method return value, which is used as reference.

🐛 Bug report

Status

Needs work

Version

11.0 🔥

Component

Field →

Last updated about 1 hour ago

Maintained by
🇷🇴Romania @amateescu

Created by

🇩🇪Germany n3or Karlsruhe

Live updates comments and jobs are added and updated live.

Needs tests
The change is currently missing an automated test that fails when run with the original code, and succeeds when the bug has been fixed.

Needs issue summary update
Issue summaries save everyone time if they are kept up-to-date. See Update issue summary task instructions.

Incomplete comments

Merge Requests

!6089WidgetBase::extractFormValues relies on non guaranteed return value
Open
🇺🇸United States beunerd
updated 6 months ago

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

First commit to issue fork.
Merge request !6089Check if extracted value is an array before trying to set/access its original delta → (Open) created by beunerd
Status changed to Needs review 6 months ago6:22pm 9 January 2024
Comment 6 months ago →
🇺🇸United States beunerd Providence, Rhode Island
This is an old issue, but I ran into something similar when using the [Password Policy]( https://www.drupal.org/project/password_policy → ) module. I *think* this is the appropriate ticket, so I've created an MR with a quick edit to check if the `$value` is an array before trying to set/access its `_original_delta` value.
Status changed to Needs work 6 months ago8:55pm 9 January 2024
Comment 6 months ago →
🇺🇸United States smustgrave
Will need test coverage also.

Also issue summary should follow standard template

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024

WidgetBase::extractFormValues relies on non guaranteed return value

Merge Requests

!6089WidgetBase::extractFormValues relies on non guaranteed return valueOpen

Comments & Activities

!6089WidgetBase::extractFormValues relies on non guaranteed return value
Open