Elgg  Version 3.0
Variables
config.php File Reference

Go to the source code of this file.

Variables

$CONFIG path
 Legacy documentation for the old $CONFIG object. More...
 
$CONFIG pluginspath
 The full path where plugins are stored. More...
 
$CONFIG wwwroot
 The full URL where Elgg is installed. More...
 
$CONFIG url
 The full URL where Elgg is installed. More...
 
$CONFIG sitename
 The name of the site as defined in the config table. More...
 
$CONFIG language
 The current language for either the site or the user. More...
 
$CONFIG installed
 Is the site fully installed. More...
 
$CONFIG site_guid
 The guid of the site object (1) More...
 
$CONFIG site
 The current site object. More...
 
$CONFIG dataroot
 The full path to the data directory. More...
 
$CONFIG simplecache_enabled
 Is simplecache enabled? More...
 
$CONFIG system_cache_enabled
 Is the system cache enabled. More...
 
$CONFIG auto_disable_plugins
 Are unbootable plugins automatically disabled. More...
 
$CONFIG sitedescription
 The site description from the current site object. More...
 
$CONFIG default_limit
 The default "limit" used in site queries. More...
 
$CONFIG view
 The current view type. More...
 
$CONFIG default_access
 Default access as defined in the config table for the current site. More...
 
$CONFIG allow_registration
 Is registration enabled? More...
 
$CONFIG walled_garden
 Is current site in walled garden mode? More...
 
$CONFIG allow_user_default_access
 Are users allow to enter their own default access levels. More...
 
$CONFIG menu_items_featured_urls
 A list of feature URLs for the main site menu. More...
 
$CONFIG menu_items_custom_items
 The custom menu items entered in the administration. More...
 
$CONFIG pluginlistcache
 A list of plugins and their load order. More...
 
$CONFIG registered_entities
 A list of registered entities and subtypes. More...
 
$CONFIG submenu_items
 Holds items for all submenus. More...
 
$CONFIG servicehandler
 Holds the service handlers as registered by {()}. More...
 
$CONFIG menucontexts
 A list of menu contexts for menus registered with add_menu(). More...
 
$CONFIG registers
 A list of registers and their children added via {()}. More...
 
$CONFIG register_objects
 A list of objects that can emit notifications. More...
 
$CONFIG lastcache
 The last cache time for the current viewtype. More...
 
$CONFIG exception_include = ''
 This is an optional script used to override Elgg's default handling of uncaught exceptions. More...
 
$CONFIG action_time_limit
 Maximum php execution time for actions (in seconds) More...
 
$CONFIG allow_phpinfo = false
 Allow access to PHPInfo. More...
 
$CONFIG bootdata_plugin_settings_limit
 Plugins with more than the configured number of plugin settings won't be loaded into bootdata cache. More...
 
$CONFIG language_to_locale_mapping
 Language to locale mapping. More...
 

Variable Documentation

$CONFIG action_time_limit

Maximum php execution time for actions (in seconds)

This setting can be used to set a custom php execution time specifically for Elgg actions. Note that if some actions set their own execution time limit, this setting will no affect those actions.

int $CONFIG->action_time_limit

Definition at line 262 of file config.php.

$CONFIG allow_phpinfo = false

Allow access to PHPInfo.

This setting can be used to allow site administrators access to the PHPInfo page. By default this is not allowed.

bool $CONFIG->allow_phpinfo

Definition at line 272 of file config.php.

$CONFIG allow_registration

Is registration enabled?

bool $CONFIG->allow_registration

Definition at line 149 of file config.php.

$CONFIG allow_user_default_access

Are users allow to enter their own default access levels.

bool $CONFIG->allow_user_default_access

Definition at line 163 of file config.php.

$CONFIG auto_disable_plugins

Are unbootable plugins automatically disabled.

See also
->load

string $CONFIG->auto_disable_plugins

Definition at line 107 of file config.php.

$CONFIG bootdata_plugin_settings_limit

Plugins with more than the configured number of plugin settings won't be loaded into bootdata cache.

This is done to prevent memory issues.

If set to < 1 all plugins will be loaded into the bootdata cache

Default: 40

int $CONFIG->bootdata_plugin_settings_limit

Definition at line 284 of file config.php.

$CONFIG dataroot

The full path to the data directory.

string $CONFIG->dataroot

Definition at line 80 of file config.php.

$CONFIG default_access

Default access as defined in the config table for the current site.

string $CONFIG->default_access

Definition at line 142 of file config.php.

$CONFIG default_limit

The default "limit" used in site queries.

int $CONFIG->default_limit

Examples:
/root/Elgg/engine/classes/ElggBatch.php.

Definition at line 121 of file config.php.

$CONFIG exception_include = ''

This is an optional script used to override Elgg's default handling of uncaught exceptions.

This should be an absolute file path to a php script that will be called any time an uncaught exception is thrown.

The script will have access to the following variables as part of the scope global $CONFIG $exception - the unhandled exception

Warning
- the database may not be available

string $CONFIG->exception_include

Definition at line 252 of file config.php.

$CONFIG installed

Is the site fully installed.

bool $CONFIG->installed

Definition at line 59 of file config.php.

$CONFIG language

The current language for either the site or the user.

$CONFIG->language

Definition at line 52 of file config.php.

$CONFIG language_to_locale_mapping

Language to locale mapping.

Some features support mapping a language to a locale setting (for example date presentations). In this setting the mapping between language (key) and locale setting (values) can be configured.

For example if you wish to present English dates in USA format make the mapping 'en' => ['en_US'], or if you wish to use UK format 'en' => ['en_UK'].

It's possible to configure the locale mapping for mulitple languages, for example: [ 'en' => ['en_US', 'en_UK'], 'nl' => ['nl_NL'], ]

It's also possible to add new languages to the supported languages: [ 'my_language' => [], // no locale mapping 'my_language2' => ['en_US'], // using USA locale mapping ]

See also
https://secure.php.net/manual/en/function.setlocale.php

array $CONFIG->language_to_locale_mapping

Definition at line 311 of file config.php.

$CONFIG lastcache

The last cache time for the current viewtype.

Used in the generation of CSS and JS links.

string $CONFIG->lastcache

Definition at line 235 of file config.php.

$CONFIG menu_items_custom_items

The custom menu items entered in the administration.

string $CONFIG->menu_items_custom_items

Definition at line 179 of file config.php.

$CONFIG menu_items_featured_urls

A list of feature URLs for the main site menu.

These links are added via the admin interface.

string $CONFIG->menu_items_featured_urls

Definition at line 172 of file config.php.

$CONFIG menucontexts

A list of menu contexts for menus registered with add_menu().

Not currently used.

array $CONFIG->menucontexts

Definition at line 214 of file config.php.

$CONFIG path

Legacy documentation for the old $CONFIG object.

In Elgg 3.0 this is a reference to the Config service.

Warning
DO NOT USE $CONFIG except in a legacy settings.php file. Note that it will be unset by the boot process after reading. The full path where Elgg is installed.

This is set in ::__construct

string $CONFIG->path;

Definition at line 17 of file config.php.

$CONFIG pluginlistcache

A list of plugins and their load order.

string $CONFIG->pluginlistcache

Definition at line 186 of file config.php.

$CONFIG pluginspath

The full path where plugins are stored.

string $CONFIG->pluginspath

Definition at line 24 of file config.php.

$CONFIG register_objects

A list of objects that can emit notifications.

register_notification_object()

array $CONFIG->register_objects

Definition at line 228 of file config.php.

$CONFIG registered_entities

A list of registered entities and subtypes.

Used in search.

array $CONFIG->registered_entities

Definition at line 193 of file config.php.

$CONFIG registers

A list of registers and their children added via {()}.

Used only for menus.

string $CONFIG->registers

Definition at line 221 of file config.php.

$CONFIG servicehandler

Holds the service handlers as registered by {()}.

array $CONFIG->servicehandler

Definition at line 207 of file config.php.

$CONFIG simplecache_enabled

Is simplecache enabled?

See also
elgg_is_simplecache_enabled() Use this instead of reading the value.

string $CONFIG->simplecache_enabled

Definition at line 89 of file config.php.

string $type object user group or site

The current site object.

ElggSite $CONFIG->site

Definition at line 73 of file config.php.

$CONFIG site_guid

The guid of the site object (1)

int $CONFIG->site_guid

Definition at line 66 of file config.php.

$CONFIG sitedescription

The site description from the current site object.

string $CONFIG->sitedescription

Definition at line 114 of file config.php.

$CONFIG sitename

The name of the site as defined in the config table.

string $CONFIG->sitename

Definition at line 45 of file config.php.

$CONFIG submenu_items

Holds items for all submenus.

string $CONFIG->submenu_items

Definition at line 200 of file config.php.

$CONFIG system_cache_enabled

Is the system cache enabled.

See also
elgg_is_system_cache_enabled() Use this instead of reading the value.

string $CONFIG->system_cache_enabled

Definition at line 98 of file config.php.

string url

The full URL where Elgg is installed.

string $CONFIG->wwwroot

Examples:
/root/Elgg/views/default/core/js/elgglib.js.

Definition at line 38 of file config.php.

$CONFIG view

The current view type.

View types determin the location of view files that are used to draw pages. They are set system-wide by the $_REQUEST['view']. If a view type is manually set in settings.php or through a function hooking to the {

Warning
This is the current view type used to determine where to load views. Don't confuse this with the current view.

string $CONFIG->view

Definition at line 135 of file config.php.

$CONFIG walled_garden

Is current site in walled garden mode?

bool $CONFIG->walled_garden

Definition at line 156 of file config.php.

$CONFIG wwwroot

The full URL where Elgg is installed.

string $CONFIG->wwwroot

Definition at line 31 of file config.php.