function settings_get | Documentation

1 bootstrap.inc settings_get($name, $default = NULL)

Returns a site-wide setting, usually specified via the settings.php file.

This returns values from the global $settings variable, with an optional default if the setting has not be specified. Settings are used for low-level, global configuration. Unlike config_get(), this function is used to retrieve values that cannot be changed via the user-interface, hence why there is no matching settings_set() function.

Parameters

string $name: The name of the setting to return.

mixed $default: (optional) The default value to use if this setting is not set.

Return value

mixed: The value of the setting, the provided default if not set.

86 calls to settings_get()

admin_bar_links_icon in core/modules/admin_bar/admin_bar.inc: Build icon menu links; mostly containing maintenance helpers.
authorize_access_allowed in core/authorize.php: Determines if the current user is allowed to run authorize.php.
BackdropHtmlToTextTestCase::testVeryLongLineWrap in core/modules/simpletest/tests/mail.test: Tests that backdrop_html_to_text() wraps before 1000 characters.
BackdropQueue::get in core/modules/system/system.queue.inc: Returns the queue object for a given name.
backdrop_bootstrap in core/includes/bootstrap.inc: Ensures Backdrop is bootstrapped to the specified phase.

... See full list

File

core/includes/bootstrap.inc, line 1233: Functions that need to be loaded on every Backdrop request.

Code

function settings_get($name, $default = NULL) {
  global $settings;

  return isset($settings[$name]) ? $settings[$name] : $default;
}