config.php File Reference

Go to the source code of this file.

Namespaces
	Elgg\Core
	Activate a plugin or plugins.

Variables
$CONFIG	language_paths
	Paths to scan for autoloading languages. More...
$CONFIG	translations
	String translations for the current language. More...
$CONFIG	registered_tag_metadata_names
	An array of metadata names to be used as tags. More...
$CONFIG	path
	The full path where Elgg is installed. More...
$CONFIG	viewpath
	The full path for core views. 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_id
	The guid of the current site object. More...
$CONFIG	site_guid
	The guid of the current site object. 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	sitedescription
	The site description from the current site object. More...
$CONFIG	siteemail
	The site email from the current site object. 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	views
	Holds information about views. More...
$CONFIG views	simplecache
	A list of views to cache in the simple cache. More...
$CONFIG views	locations
	A list of views and the top level views directory to search for the view in. More...
$CONFIG	view_types
	A list of valid view types as discovered. More...
$CONFIG	pluginlistcache
	A list of plugins and their load order. More...
$CONFIG	registered_entities
	A list of registered entities and subtypes. More...
$CONFIG	independents
	A list of entity types and subtypes that have metadata whose access permission can be changed independently of the main object. More...
$CONFIG	submenu_items
	Holds items for all submenus. More...
$CONFIG	servicehandler
	Holds the service handlers as registered by {()}. More...
$CONFIG	wordblacklist
	A list of stop works for search. 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	group_tool_options
	Holds available group tools options. 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...

Variable Documentation

$CONFIG allow_registration

Is registration enabled?

bool $CONFIG->allow_registration

Definition at line 199 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 213 of file config.php.

$CONFIG dataroot

The full path to the data directory.

string $CONFIG->dataroot

Definition at line 143 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 192 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 358 of file config.php.

$CONFIG group_tool_options

Holds available group tools options.

Added with add_group_tool_option()

array $CONFIG->group_tool_options

Definition at line 334 of file config.php.

$CONFIG independents

A list of entity types and subtypes that have metadata whose access permission can be changed independently of the main object.

register_metadata_as_indepenent()

string $CONFIG->independents

Definition at line 284 of file config.php.

$CONFIG installed

Is the site fully installed.

bool $CONFIG->installed

Definition at line 115 of file config.php.

string language

The current language for either the site or the user.

$CONFIG->language

Definition at line 108 of file config.php.

$CONFIG language_paths

Paths to scan for autoloading languages.

Languages are automatically loaded for the site or user's default language. Plugins can extend or override strings. language_paths is an array of paths to scan for PHP files matching the default language. The order of paths is determined by the plugin load order, with later entries overriding earlier. Language files within these paths are named as the two-letter ISO 639-1 country codes for the language they represent.

Language paths are stored as array keys in the format: $CONFIG->language_paths[str $language_path] = true

register_language() array $CONFIG->language_paths

Definition at line 30 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 341 of file config.php.

$CONFIG views locations

A list of views and the top level views directory to search for the view in.

Note

Views are stored as the key and the top level view location is stored as the value. The current viewtype ->view is used to determin which directory under the entry in $CONFIG->views->location to search. View names are automatically appened a '.php' extension.

object $CONFIG->views->locations

Definition at line 254 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 229 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 222 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 313 of file config.php.

$CONFIG path

The full path where Elgg is installed.

string $CONFIG->path;

Definition at line 66 of file config.php.

$CONFIG pluginlistcache

A list of plugins and their load order.

string $CONFIG->pluginlistcache

Definition at line 269 of file config.php.

$CONFIG pluginspath

The full path where plugins are stored.

string $CONFIG->pluginspath

Definition at line 80 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 327 of file config.php.

$CONFIG registered_entities

A list of registered entities and subtypes.

Used in search.

array $CONFIG->registered_entities

Definition at line 276 of file config.php.

$CONFIG registered_tag_metadata_names

An array of metadata names to be used as tags.

Because tags are simply names of meatdata, This is used in search to prevent data exposure by searching on arbitrary metadata.

array $CONFIG->registered_tag_metadata_names

Definition at line 59 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 320 of file config.php.

$CONFIG servicehandler

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

array $CONFIG->servicehandler

Definition at line 298 of file config.php.

$CONFIG views simplecache

A list of views to cache in the simple cache.

object $CONFIG->views->simplecache

Definition at line 243 of file config.php.

$CONFIG simplecache_enabled

Is simplecache enabled?

string $CONFIG->simplecache_enabled

Definition at line 150 of file config.php.

elgg heading elgg heading site

The current site object.

ElggSite $CONFIG->site

Definition at line 136 of file config.php.

number site_guid

The guid of the current site object.

int $CONFIG->site_id

Definition at line 129 of file config.php.

$CONFIG site_id

The guid of the current site object.

int $CONFIG->site_id

Definition at line 122 of file config.php.

$CONFIG sitedescription

The site description from the current site object.

string $CONFIG->sitedescription

Definition at line 164 of file config.php.

$CONFIG siteemail

The site email from the current site object.

string $CONFIG->siteemail

Definition at line 171 of file config.php.

$CONFIG sitename

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

string $CONFIG->sitename

Definition at line 101 of file config.php.

$CONFIG submenu_items

Holds items for all submenus.

string $CONFIG->submenu_items

Definition at line 291 of file config.php.

$CONFIG system_cache_enabled

Is the system cache enabled.

string $CONFIG->system_cache_enabled

Definition at line 157 of file config.php.

$CONFIG translations

String translations for the current language.

Elgg uses a key-based system for string internationalization, which is accessed with elgg_echo().

Translations are stored as an array in the following format: $CONFIG->translations[str $language_code][str $string_key] = str 'Translated Language String';

See also

register_translation()

elgg_echo() array $CONFIG->translations

Definition at line 48 of file config.php.

string url

The full URL where Elgg is installed.

string $CONFIG->wwwroot

Examples:

/root/Elgg/js/lib/elgglib.js.

Definition at line 94 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 185 of file config.php.

$CONFIG view_types

A list of valid view types as discovered.

array $CONFIG->view_types

Definition at line 262 of file config.php.

$CONFIG viewpath

The full path for core views.

string $CONFIG->viewpath

Definition at line 73 of file config.php.

$CONFIG views

Holds information about views.

object $CONFIG->views

Definition at line 236 of file config.php.

$CONFIG walled_garden

Is current site in walled garden mode?

bool $CONFIG->walled_garden

Definition at line 206 of file config.php.

$CONFIG wordblacklist

A list of stop works for search.

Not currently used.

array $CONFIG->wordblacklist

Definition at line 306 of file config.php.

$CONFIG wwwroot

The full URL where Elgg is installed.

string $CONFIG->wwwroot

Definition at line 87 of file config.php.