Using include_once / require_once in settings.php leads to unexpected behavior

So, predefining $config_directories works, but moving it to a require_once at the same place, it is ignored. Can you reproduce this on 8.2.x? I ask because there was an issue I can't find at the moment that was similar.

Can't reproduce on 8.2.x

Should the fix be back ported to 8.1?

In #4, This was reported fixed in 8.2.0-beta3. It was reopened in #6 in the hope it was backported and to help others. That was over four years and and 8.2.x is no longer supported. It seems sensible to close this as outdated.

I seem to be able to reproduce this on Drupal 9.1.

Here is what I did:

1. Make settings.php include another file named settings.included.php (note the use of require_once instead of require)
   

   $ ls default/
   settings.php
   settings.included.php
   
   $ cat default/settings.php
   <?php
   require_once __DIR__ . '/settings.included.php';
   
   $ cat default/settings.included.php
   <?php
   $settings['hash_salt'] = 'foo';
   $settings['config_sync_directory'] = '../config/sync';
   $settings['trusted_host_patterns'] = ['^localhost$'];
   $databases['default']['default'] = [
     'database' => 'drupal',
     'username' => 'root',
     'password' => 'abcd',
     'prefix' => '',
     'host' => 'mysqld',
     'port' => '3306',
     'namespace' => 'Drupal\\Core\\Database\\Driver\\mysql',
     'driver' => 'mysql',
   ];
     

2. Mount our settings files against a Drupal 9 infrastructure
   

   $ cat docker-compose.yml 
   version: '3'
   services:
     drupal:
       image: drupal:9-apache
       volumes:
         - ./default:/var/www/html/sites/default
     mysqld:
       image: mysql:5.7
       environment:
         MYSQL_DATABASE: drupal
         MYSQL_ROOT_PASSWORD: abcd
         MYSQL_INITDB_SKIP_TZINFO: 1
   
   $ docker-compose up -d
   
   $ docker-compose exec drupal composer require drush/drush
     

3. Install site
   

   $ docker-compose exec drupal /bin/bash
   /opt/drupal# mkdir -p web/sites/default/files
   /opt/drupal# chmod a+w web/sites/default/settings*.php web/sites/default/files
   /opt/drupal# drush -y site-install minimal
     

4. Expected result: settings.php is left untouched
   

   /opt/drupal# cat web/sites/default/settings.php
   <?php
   require_once __DIR__ . '/settings.included.php';
     

5. Actual result: config directory, database credentials, salt are appended to settings.php
   

   /opt/drupal# cat web/sites/default/settings.php
   <?php
   require_once __DIR__ . '/settings.included.php';
   $databases['default']['default'] = array (
     'database' => 'drupal',
     'username' => 'root',
     'password' => 'abcd',
     'prefix' => '',
     'host' => 'mysqld',
     'port' => '3306',
     'namespace' => 'Drupal\\Core\\Database\\Driver\\mysql',
     'driver' => 'mysql',
   );
   $settings['hash_salt'] = 'uQJJSc9OoP-LjGLmB8hyFYsqIplsIt4LD4s2KxIhbJEmHIYr6iNTcnk6wRzfSY02vyAdwo7Jxg';
   $settings['config_sync_directory'] = 'sites/default/files/config_CQSDgwm40VWDAtA0VFF4n6jxSHm3uQEwCzh2ivdvybyMWh7acmcSAn53rz8-ZuBF7eBNneouYQ/sync';
     

6. Now repeat the test with require instead of require_once
   

   $ cat default/settings.php
   <?php
   require __DIR__ . '/settings.included.php';
   
   $ docker-compose exec drupal /bin/bash
   /opt/drupal# drush -y site-install minimal
     

7. This time settings.php will be left untouched, as expected
   

   /opt/drupal# cat web/sites/default/settings.php
   <?php
   require __DIR__ . '/settings.included.php';
     

Maybe we could document this in sites/default/default.settings.php ? I have opened project/drupal!488.

Can the MR be updated for 10.1 please.

This issue is now making my drush calls fail on Drupal 10.1 because my skeleton settings.php used require_once to grab pretty much *all* actual config from a place I manage with config-as-code tools. When I run drush I get:

In Settings.php line 171:                                                    
    Missing $settings['hash_salt'] in settings.php.

Of course, when Drupal is accessed through the web server, it bootstraps fine and everything works as expected.

We're running into the same issue as #19. The error is triggered when using `include_once`. With `include` it works just fine.

For us the error message only happens when using Drush 12. With Drush 11 it works fine.

In Settings.php line 171:                                                    
    Missing $settings['hash_salt'] in settings.php.

A colleague reports discovering a problem with require/require_once in 10.3. Our settings.php file requires default.settings.php and then adds some customization. What we found:

BUT instead it HAS TO BE
"require('default.settings.php')". During a cache clear request
\Drupal\Core\Site\Settings.php gets initialized twice (once before clearing,
once after). Each time Settings::initialize() invokes "require
sites/default/settings.php". It has to return the exact same information both
times. But the require_once line meant that the second time around it was
dropping default.settings.php.