> For the complete documentation index, see [llms.txt](https://devguide.e107.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://devguide.e107.org/templates-shortcodes-and-constants/constants.md).

# Constants

{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}

## Introduction

.....

## Directory constants

{% hint style="info" %}
In the table below `(hash)` refers to the :point\_right: [hash](https://userguide.e107.org/installation-and-maintenance/folders-files-hash#hash) generated upon installation of e107. &#x20;
{% endhint %}

| Constant                | Description | Example value                         |
| ----------------------- | ----------- | ------------------------------------- |
| e\_ADMIN                |             | /e107\_admin/                         |
| e\_ADMIN\_ABS           |             | /e107\_admin/                         |
| e\_AVATAR               |             | ./e107\_media/(hash)/avatars/         |
| e\_AVATAR\_ABS          |             | /e107\_media/(hash)/avatars/          |
| e\_AVATAR\_DEFAULT      |             | ./e107\_media/(hash)/avatars/default/ |
| e\_AVATAR\_DEFAULT\_ABS |             | /e107\_media/(hash)/avatars/default/  |
| e\_AVATAR\_UPLOAD       |             | ./e107\_media/(hash)/avatars/upload/  |
| e\_AVATAR\_UPLOAD\_ABS  |             | /e107\_media/(hash)/avatars/upload/   |
| e\_BACKUP               |             | ./e107\_system/(hash)/backup/         |
| e\_BOOTSTRAP            |             | ./e107\_web/bootstrap/                |
| e\_CACHE                |             | ./e107\_system/(hash)/cache/          |
| e\_CACHE\_CONTENT       |             | ./e107\_system/(hash)/cache/content/  |
| e\_CACHE\_DB            |             | ./e107\_system/(hash)/cache/db/       |
| e\_CACHE\_IMAGE         |             | ./e107\_system/(hash)/cache/images/   |
| e\_CACHE\_IMAGE\_ABS    |             | /e107\_system/(hash)/cache/images/    |
| e\_CACHE\_URL           |             | ./e107\_system/(hash)/cache/url/      |
| e\_CORE                 |             | ./e107\_core/                         |
| e\_CSS                  |             | /e107\_web/css/                       |
| e\_CSS\_ABS             |             | /e107\_web/css/                       |
| e\_DOCROOT              |             | C:/webdev/www/                        |
| e\_DOCS                 |             | ./e107\_docs/help/                    |
| e\_DOCS\_ABS            |             | /e107\_docs/                          |
| e\_DOWNLOAD             |             | ./e107\_media/(hash)/files/           |
| e\_FILE                 |             | ./e107\_files/                        |
| e\_FILE\_ABS            |             | /e107\_files/                         |
| e\_HANDLER              |             | ./e107\_handlers/                     |
| e\_HELP                 |             | ./e107\_docs/help/                    |
| e\_HELP\_ABS            |             | /e107\_docs/help/                     |
| e\_IMAGE                |             | ./e107\_images/                       |
| e\_IMAGE\_ABS           |             | /e107\_images/                        |
| e\_IMPORT               |             | ./e107\_system/(hash)/import/         |
| e\_IMPORT\_ABS          |             |                                       |
| e\_JS                   |             | /e107\_web/js/                        |
| e\_JS\_ABS              |             | /e107\_web/js/                        |
| e\_LANGUAGEDIR          |             | ./e107\_languages/                    |
| e\_LOG                  |             | ./e107\_system/(hash)/logs/           |
| e\_MEDIA                |             | ./e107\_media/(hash)/                 |
| e\_MEDIA\_ABS           |             | /e107\_media/(hash)/                  |
| e\_MEDIA\_BASE          |             | ./e107\_media/                        |
| e\_MEDIA\_FILE          |             | ./e107\_media/(hash)/files/           |
| e\_MEDIA\_FILE\_ABS     |             | /e107\_media/(hash)/files/            |
| e\_MEDIA\_ICON          |             | ./e107\_media/(hash)/icons/           |
| e\_MEDIA\_ICON\_ABS     |             | /e107\_media/(hash)/icons/            |
| e\_MEDIA\_IMAGE         |             | ./e107\_media/(hash)/images/          |
| e\_MEDIA\_IMAGE\_ABS    |             | /e107\_media/(hash)/images/           |
| e\_MEDIA\_VIDEO         |             | ./e107\_media/(hash)/videos/          |
| e\_MEDIA\_VIDEO\_ABS    |             | /e107\_media/(hash)/videos/           |
| e\_PLUGIN               |             | ./e107\_plugins/                      |
| e\_PLUGIN\_ABS          |             | /e107\_plugins/                       |
| e\_ROOT                 |             | C:\webdev\www\\                       |
| e\_SYSTEM               |             | ./e107\_system/(hash)/                |
| e\_SYSTEM\_BASE         |             | ./e107\_system/                       |
| e\_TEMP                 |             | ./e107\_system/(hash)/temp/           |
| e\_THEME                |             | ./e107\_themes/                       |
| e\_THEME\_ABS           |             | /e107\_themes/                        |
| e\_UPLOAD               |             | ./e107\_system/(hash)/temp/           |
| e\_WEB                  |             | ./e107\_web/                          |
| e\_WEB\_ABS             |             | /e107\_web/                           |
| e\_WEB\_CSS             |             | ./e107\_web/css/                      |
| e\_WEB\_IMAGE           |             | ./e107\_web/images/                   |
| e\_WEB\_IMAGE\_ABS      |             | /e107\_web/images/                    |
| e\_WEB\_JS              |             | ./e107\_web/js/                       |

## Path constants

| Constant      | Description | Example value |
| ------------- | ----------- | ------------- |
| e\_HTTP       |             |               |
| SITEURLBASE   |             |               |
| SITEURL       |             |               |
| e\_BASE       |             |               |
| e\_BASE\_SELF |             |               |
| e\_SELF       |             |               |
| THEME         |             |               |
| THEME\_ABS    |             |               |
| e\_ROOT       |             |               |
| e\_ROUTE      |             |               |
| e\_PAGE       |             |               |
| e\_LOGIN      |             |               |

## User constants

| Constant         | Description                                      | Example value                           |
| ---------------- | ------------------------------------------------ | --------------------------------------- |
| USER             | <p>Shows if a user is logged in<br>(boolean)</p> | 1                                       |
| USERCLASS        |                                                  |                                         |
| USERCLASS\_LIST  | Userclasses the user belongs to                  | 253,254,250,251,0                       |
| USERCURRENTVISIT | UNIX timestamp....                               | 1615651180                              |
| USEREMAIL        |                                                  | <admin@mywebsite.com>                   |
| USERID           |                                                  | 1                                       |
| USERIMAGE        |                                                  | zaqRWcP-\_400x400.jpg                   |
| USERIP           |                                                  | 0000:0000:0000:0000:0000:ffff:7f00:0001 |
| USERJOINED       |                                                  | 1588259340                              |
| USERLAN          |                                                  | English                                 |
| USERLV           |                                                  | 1615499410                              |
| USERNAME         |                                                  | Administrator                           |
| USERPHOTO        |                                                  |                                         |
| USERSIGNATURE    |                                                  |                                         |
| USERTHEME        |                                                  |                                         |
| USERTIMEZONE     |                                                  | UTC                                     |
| USERURL          |                                                  |                                         |
| USERVISITS       |                                                  | 82                                      |

## General Site Constants

| Constant        | Description | Example value                                                                                                                                                                                                                                                             |
| --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| SITEADMIN       |             | Administrator                                                                                                                                                                                                                                                             |
| SITEADMINEMAIL  |             | <admin@mywebsite.com>                                                                                                                                                                                                                                                     |
| SITEBUTTON      |             | /e107\_images/button.png                                                                                                                                                                                                                                                  |
| SITECONTACTINFO |             | \<strong class='bbcode bold bbcode-b'>My Company\</strong>\<br />13 My Address St.\<br />City, State, Country\<br />\<strong class='bbcode bold bbcode-b'>Phone:\</strong> 555-555-5555\<br />\<strong class='bbcode bold bbcode-b'>Email:\</strong> <sales@mydomain.com> |
| SITEDESCRIPTION |             |                                                                                                                                                                                                                                                                           |
| SITEDISCLAIMER  |             |                                                                                                                                                                                                                                                                           |
| SITEEMAIL       |             | <admin@mywebsite.com>                                                                                                                                                                                                                                                     |
| SITENAME        |             | MyWebsite                                                                                                                                                                                                                                                                 |
| SITETAG         |             | e107 Website System                                                                                                                                                                                                                                                       |
| SITEURL         |             | <http://clean3004.test/>                                                                                                                                                                                                                                                  |
| SITEURLBASE     |             | <http://clean3004.test>                                                                                                                                                                                                                                                   |

## Userclass constants

......

| Constant             | ID  | Description                                               |
| -------------------- | --- | --------------------------------------------------------- |
| e\_UC\_PUBLIC        | 0   |                                                           |
| e\_UC\_MAINADMIN     | 250 |                                                           |
| e\_UC\_READONLY      | 251 |                                                           |
| e\_UC\_GUEST         | 252 |                                                           |
| e\_UC\_MEMBER        | 253 |                                                           |
| e\_UC\_ADMIN         | 254 |                                                           |
| e\_UC\_NOBODY        | 255 |                                                           |
| e\_UC\_ADMINMOD      | 249 | Admins (includes main admins)                             |
| e\_UC\_MODS          | 248 | Moderators (who aren't admins)                            |
| e\_UC\_NEWUSER       | 247 | Users in 'probationary' period                            |
| e\_UC\_BOTS          | 246 | Reserved to identify search bots                          |
| e\_UC\_SPECIAL\_BASE | 243 | Assign class IDs 243 and above for fixed/special purposes |
| e\_UC\_SPECIAL\_END  | 255 | Highest 'special' class                                   |

{% hint style="info" %}
Userclass constants ID's 243 - 245 are reserved for future predefined user classes
{% endhint %}

## Language constants

| Constant    | Description | Example value |
| ----------- | ----------- | ------------- |
| e\_LAN      |             |               |
| e\_LANCODE  |             |               |
| e\_LANGUAGE |             |               |
| e\_LANLIST  |             |               |
| e\_LANQRY   |             |               |

## Development constants

// define('e*DEBUG', true); // Enable debug mode to allow displaying of errors* \
*// define('e\_HTTP\_STATIC', '*<https://static.mydomain.com/>*'); // Use a static subdomain for js/css/images etc.* \
*// define('e\_MOD\_REWRITE\_STATIC', true); // Rewrite static image urls.* \
*// define('e\_LOG\_CRITICAL', true); // log critical errors but do not display them to user.* \
*// define('e\_GIT', 'path-to-git'); // Path to GIT for developers* \
*// define('X-FRAME-SAMEORIGIN', false); // Option to override X-Frame-Options*\
&#x20;*// define('e\_PDO, true); // Enable PDO mode (used in PHP > 7 and when mysql*\* methods are not available)

| Constant                | Description | Example value |
| ----------------------- | ----------- | ------------- |
| e\_DEBUG                |             | 1             |
| e\_DEBUG\_CANONICAL     |             |               |
| e\_DEBUG\_JS\_FOOTER    |             |               |
| e\_DEVELOPER            |             | 1             |
| e\_MENU                 |             |               |
| e\_MOD\_REWRITE         |             | 1             |
| e\_MOD\_REWRITE\_MEDIA  |             | 1             |
| e\_MOD\_REWRITE\_STATIC |             | 1             |
| e\_NOCACHE              |             |               |
| e\_SECURITY\_LEVEL      |             | 5             |
| e\_SINGLE\_ENTRY        |             |               |
| e\_TOKEN                |             |               |

## Theme constants

| Constant       | Description | Example value              |
| -------------- | ----------- | -------------------------- |
| THEME          |             | ./e107\_themes/bootstrap3/ |
| THEME\_ABS     |             | /e107\_themes/bootstrap3/  |
| THEME\_LAYOUT  |             | jumbotron\_home            |
| THEME\_LEGACY  |             |                            |
| THEME\_STYLE   |             | style.css                  |
| THEME\_VERSION |             | 2.3                        |

## Plugin constants

| Constant            | Description | Example value |
| ------------------- | ----------- | ------------- |
| e\_PLUGIN\_DIR\_ABS |             |               |

### Core plugins

#### Social plugin

| Constant        | Description | Example value |
| --------------- | ----------- | ------------- |
| XURL\_FACEBOOK  |             |               |
| XURL\_TWITTER   |             |               |
| XURL\_YOUTUBE   |             |               |
| XURL\_GOOGLE    |             |               |
| XURL\_LINKEDIN  |             |               |
| XURL\_GITHUB    |             |               |
| XURL\_FLICKR    |             |               |
| XURL\_INSTAGRAM |             |               |
| XURL\_PINTEREST |             |               |
| XURL\_STEAM     |             |               |
| XURL\_VIMEO     |             |               |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://devguide.e107.org/templates-shortcodes-and-constants/constants.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
