function _drupal_rewrite_settings_dump

Same name in other branches
  1. 9 core/includes/install.inc \_drupal_rewrite_settings_dump()
  2. 8.9.x core/includes/install.inc \_drupal_rewrite_settings_dump()

Helper for drupal_rewrite_settings().

Dump the relevant value properties.

Parameters

array|object $variable: The container for variable values.

string $variable_name: Name of variable.

Return value

string A string containing valid PHP code of the variable suitable for placing into settings.php.

Deprecated

in drupal:10.1.0 and is removed from drupal:11.0.0. Use SettingsEditor::rewrite() instead. As internal API, _drupal_rewrite_settings_dump() may also be removed in a minor release.

See also

https://www.drupal.org/node/3244583

File

core/includes/install.inc, line 391

Code

function _drupal_rewrite_settings_dump($variable, $variable_name) {
    @trigger_error(__FUNCTION__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use SettingsEditor::rewrite() instead. As internal API, ' . __FUNCTION__ . '() may also be removed in a minor release. See https://www.drupal.org/node/3244583', E_USER_DEPRECATED);
    $return = '';
    if (is_object($variable)) {
        if (!empty($variable->required)) {
            $return .= _drupal_rewrite_settings_dump_one($variable, "{$variable_name} = ", "\n");
        }
    }
    else {
        foreach ($variable as $k => $v) {
            $return .= _drupal_rewrite_settings_dump($v, $variable_name . "['" . $k . "']");
        }
    }
    return $return;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.