Table of Contents
Global Variables
Introduction
Nucleus defines a large number of global variables, some of which are objects and some of which are arrays. These variables contain a large amount of information that may be valuable to a plugin developer. In accessing these variables, however, the developer is reminded not to potentially cause problems with Nucleus by changing the values of these variables.
Variables
| Name | Type | Description |
|---|---|---|
| $action |  | |
| $amount | Integer | Number of search results to show |
| $archive | | |
| $archivelist | | |
| $BLOG | Object | Contains blog settings |
| $blogid | Integer | ID of currently-displayed blog |
| $catid | Integer | ID of currently-displayed category (0 if not defined) |
| $CONF | Object | Contains global settings |
| $currentSkinName | String | Name of currently-used skin |
| $currentTemplateName | String | Name of currently-used template |
| $data | Array | |
| $DIR_LANG | String | Full path to language files |
| $DIR_LIBS | String | Full path to library files |
| $DIR_MEDIA | String | Full path to uploaded media files |
| $DIR_NUCLEUS | String | Full path to Nucleus admin area |
| $DIR_PLUGINS | String | Full path to plugin files |
| $DIR_SKINS | String | Full path to skin files |
| $error | | |
| $errormessage | String | Error message to display |
| $highlight | | |
| $i | | |
| $imagepopup | | |
| $itemid | Integer | ID of currently-displayed item |
| $itemidnext | Integer | ID of next item |
| $itemidprev | Integer | ID of previous item |
| $language | String | Current language |
| $manager | Object | Multi-level object containing Nucleus manager information |
| $maxresults | | |
| $MEMBER | Object | Contains information of currently logged-in member |
| $memberid | | |
| $MEMBERINFO | Object | Contains information of member on currently-displayed member page |
| $MYSQL_DATABASE | String | MySQL database name |
| $MYSQL_HOST | String | MySQL server hostname |
| $MYSQL_PASSWORD | String | Raw MySQL password |
| $MYSQL_PREFIX | String | MySQL prefix |
| $MYSQL_USER | String | MySQL user |
| $nextaction | | |
| $nucleus | Array | Contains information about the Nucleus installation |
| $parsed | | |
| $query | String | Current search query |
| $res | | |
| $skinid | Integer | ID of currently-used skin |
| $startpos | | |
$data
Array keys
$nucleus
Array keys
| Name | Type | Description |
|---|---|---|
| version | String | Nucleus version number |
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported
