PHP8.1 deprecation: str_replace(): Passing null to parameter #3

We just saw this after moving to 8.1. As I understand it, this will break in a future version of php and the fix in the patch is a correct and reasonable way to provide the correct type to the core function. Moving this to "needs review" and hoping we can move this to RTBC

From reading the comments this seems like this can be caused by contrib modules using the wrong code.

If we were to add this having test coverage would be good.

I'm willing to add a test, but what would the test case be?

I think the proposed fix, a single line change, is a reasonable and least disruptive change:
$text = $element['#text'] ?? ''

Other solutions that occur to me are to cast $element['#text'] to string explicitly, but we haven't been having problems with passing non-strings in general as that would likely throw an exception when the non-string was passed to str_replace().

The patch works however I found a way to avoid using the patch.

In our case, the problem came from our custom theme code, in the exception message I saw near the top of the exception the hint: mymodule_preprocess_ds_1col

Deprecated function: str_replace(): Passing null to parameter #3 ($subject) of type array|string is deprecated in Drupal\Component\Utility\Html::cleanCssIdentifier() (line 107 of core/lib/Drupal/Component/Utility/Html.php).

Drupal\Component\Utility\Html::cleanCssIdentifier(NULL) (Line: 23)
mymodule_preprocess_ds_1col(Array, 'ds_1col', Array)

From there, I grepped (searched) through our custom code and I found the mymodule_preprocess_ds_1col function and in that function we were not validating for a null parameter

so I fixed the code as follows:

diff --git a/docroot/themes/custom/rmytheme/includes/content.inc b/docroot/themes/custom/mytheme/includes/content.inc
index ed348eb9aa..c625023421 100644
--- a/docroot/themes/custom/mytheme/includes/content.inc
+++ b/docroot/themes/custom/mytheme/includes/content.inc
@@ -20,7 +20,12 @@ function mytheme_preprocess_ds_1col(&$variables) {
       $niveau_entity = $niveau_entity->getTranslation($lang_code);
     }
     $niveau = $niveau_entity->description->value;
-    $classname = 'alerte-niveau-'.mb_strtolower(HTML::cleanCssIdentifier($niveau));
+    if (empty($niveau)) {
+      $classname = 'alerte-niveau-';
+    }
+    else {
+      $classname = 'alerte-niveau-'.mb_strtolower(HTML::cleanCssIdentifier($niveau));
+    }
     $variables['attributes']['class'][] = $classname;
     $variables['niveau'] = $niveau;
   }

Hope this helps someone else.

This is still an issue in 11.x.

Even if this deprecation message is only triggered by contrib/custom code, I agree that core could be more defensive here.

Attaching new version of the patch including basic test coverage.

The last submitted patch, 22: 3294680-22-test-only.patch, failed testing. View results →

Lets see what the committers think.

Thanks for the test case definitely helps this potentially getting in.

The last submitted patch, 22: 3294680-22.patch, failed testing. View results →

I believe the Rules module is the reason I am getting this error as well see the details here: https://www.drupal.org/project/rules/issues/3285721#comment-15186484 ✨ Unable to get variable 'user' Needs review ;

Because a patch was not available there I was able to resolve the issue by adding the patch marcoscano provided in comment #2 ( https://www.drupal.org/project/drupal/issues/3294680#comment-14597409 🐛 PHP8.1 deprecation: str_replace(): Passing null to parameter #3 Needs work )

I patched #2 with drupal 10.1.3 and I so far haven't come across this error message in my logs.

Patch #2 solves it for me when using Twig Tweaks filter {{ $some_value | check_markup('restricted_html') }} if $some_value is null.
Thanks!

Patch is working and looks reasonable to me.

The Needs Review Queue Bot → tested this issue.

While you are making the above changes, we recommend that you convert this patch to a merge request → . Merge requests are preferred over patches. Be sure to hide the old patch files as well. (Converting an issue to a merge request without other contributions to the issue will not receive credit.)

Ruslan Piskarov → made their first commit to this issue’s fork.

I can't create new branch for 11.x-dev.

Just fyi #22 still cleanly applied

haven't really tracked down how NULL gets in there in my scenario, but I wonder if just defaulting to an empty string could make sense here.

Going off the issue summary this needs to be answered.

I see the same error.

Deprecated function: str_replace(): Passing null to parameter #3 ($subject) of type array|string is deprecated in Drupal\file\Plugin\Field\FieldType\FileItem->fieldSettingsForm() (line 177 of core/modules/file/src/Plugin/Field/FieldType/FileItem.php).
Drupal\file\Plugin\Field\FieldType\FileItem->fieldSettingsForm(Array, Object) (Line: 207)
Drupal\image\Plugin\Field\FieldType\ImageItem->fieldSettingsForm(Array, Object) (Line: 219)
Drupal\field_ui\Form\FieldConfigEditForm->form(Array, Object) (Line: 107)
Drupal\Core\Entity\EntityForm->buildForm(Array, Object)
call_user_func_array(Array, Array) (Line: 536)
Drupal\Core\Form\FormBuilder->retrieveForm('field_config_edit_form', Object) (Line: 283)
Drupal\Core\Form\FormBuilder->buildForm(Object, Object) (Line: 73)
Drupal\Core\Controller\FormController->getContentResult(Object, Object) (Line: 39)
Drupal\layout_builder\Controller\LayoutBuilderHtmlEntityFormController->getContentResult(Object, Object)
call_user_func_array(Array, Array) (Line: 123)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() (Line: 627)
Drupal\Core\Render\Renderer->executeInRenderContext(Object, Object) (Line: 124)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->wrapControllerExecutionInRenderContext(Array, Array) (Line: 97)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() (Line: 181)
Symfony\Component\HttpKernel\HttpKernel->handleRaw(Object, 1) (Line: 76)
Symfony\Component\HttpKernel\HttpKernel->handle(Object, 1, 1) (Line: 58)
Drupal\Core\StackMiddleware\Session->handle(Object, 1, 1) (Line: 48)
Drupal\Core\StackMiddleware\KernelPreHandle->handle(Object, 1, 1) (Line: 28)
Drupal\Core\StackMiddleware\ContentLength->handle(Object, 1, 1) (Line: 106)
Drupal\page_cache\StackMiddleware\PageCache->pass(Object, 1, 1) (Line: 85)
Drupal\page_cache\StackMiddleware\PageCache->handle(Object, 1, 1) (Line: 48)
Drupal\Core\StackMiddleware\ReverseProxyMiddleware->handle(Object, 1, 1) (Line: 51)
Drupal\Core\StackMiddleware\NegotiationMiddleware->handle(Object, 1, 1) (Line: 36)
Drupal\Core\StackMiddleware\AjaxPageState->handle(Object, 1, 1) (Line: 51)
Drupal\Core\StackMiddleware\StackedHttpKernel->handle(Object, 1, 1) (Line: 704)
Drupal\Core\DrupalKernel->handle(Object) (Line: 19)

Can the question in the proposed solution be answered please.

#2 works with `10.2.6`

I encountered the same issue. #38 works for me, Drupal 10.2.6.

Added steps to reproduce and MR is still valid. Moving to NR

The Needs Review Queue Bot → tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.

MR is back to green after merging 11.x again.

smustgrave → changed the visibility of the branch 3294680-php8.1-deprecation-strreplace to hidden.

smustgrave → changed the visibility of the branch 3294680-D10.1-php8.1-deprecation-strreplace to hidden.

Hiding patches as fix is in MR.

Ran test-only feature

1) /builds/issue/drupal-3294680/core/modules/filter/src/Element/ProcessedText.php:106
str_replace(): Passing null to parameter #3 ($subject) of type array|string is deprecated
Triggered by:
* Drupal\Tests\filter\Kernel\FilterAPITest::testProcessedTextElement
  /builds/issue/drupal-3294680/core/modules/filter/tests/src/Kernel/FilterAPITest.php:250
OK, but there were issues!
Tests: 8, Assertions: 79, Deprecations: 1.

Not sure if something should be done to address '#text' => NULL, being allowed but current solution does fix the problem.