Global Template Variables
From phpBB Development Wiki
General Variables
| Variable | Description | Raw Code Example | Rendered Example |
|---|---|---|---|
| A_COOKIE_SETTINGS | Type: String Cookie settings with single quotes, double quotes and backslashes escaped. |
; path=/; domain=.phpbb.com |
|
| BOARD_URL | Type: URL Board URL. |
http://localhost/phpBB3/ |
|
| CURRENT_TIME | Type: Language string Current time. |
It is currently Sun Dec 19, 2010 9:39 pm |
|
| DEBUG_OUTPUT | Type: Language string Debug output. |
Time : 0.145s | 10 Queries | GZIP : Off | Memory Usage: 3.63 MiB | <a href="./index.php?&explain=1">Explain</a> |
10 Queries | GZIP : Off | Memory Usage: 3.63 MiB | Explain |
| LAST_VISIT_DATE | Type: Language string Last visit date. |
Last visit was: Sun Dec 19, 2010 8:21 pm |
|
| LAST_VISIT_YOU | Type: Language string Last visit date. |
Sun Dec 19, 2010 8:21 pm |
|
| LOGGED_IN_USER_LIST | Type: Language string List of logged in users. |
Registered users: <a href="./memberlist.php?mode=viewprofile&u=56" style="color: #AA0000;" class="username-coloured">x14</a> |
Registered users: x14 |
| L_INDEX | Type: Language string Board index |
Board index |
|
| L_LOGIN_LOGOUT | Type: Conditional language string Returns Login or Logout [ Username ] based on the user's logged in status. |
Logout [ BertieZilla ] |
|
| L_ONLINE_EXPLAIN | Type: Language string Who is online time span. |
based on users active over the past 5 minutes |
|
| PAGE_TITLE | Type: Language string Current page title. |
Index page |
|
| PRIVATE_MESSAGE_INFO | Type: Language string Total number of new messages. Private messages are considered "new" until the user views his inbox. |
<strong>1</strong> new message |
1 new message |
| PRIVATE_MESSAGE_INFO_UNREAD | Type: Language string Total number of unread messages. |
<strong>3</strong> unread messages |
3 unread messages |
| RECORD_USERS | Type: Language string Record number of most users ever online. |
Most users ever online was <strong>4</strong> on Fri May 28, 2010 11:30 am |
Most users ever online was 4 on Fri May 28, 2010 11:30 am |
| ROOT_PATH | Type: URL Path to the phpBB root. |
./ |
|
| RUN_CRON_TASK | Type: Image Used for board cron tasks such as pruning. |
<img src="./cron.php?cron_type=tidy_sessions" width="1" height="1" alt="cron" /> |
|
| SCRIPT_NAME | Type: String Current script (index.php, viewforum.php, viewtopic.php, etc.) with its file extension removed. |
index |
|
| SESSION_ID | Type: String User's session ID. Unlike {_SID}, {SESSION_ID} will always return a value. |
081fc77923200cd6b61de25ebc9ab484 |
|
| SID | Type: String Session ID parameter. The actual session value will only be appended to the parameter if the user does not have cookies enabled on his browser. |
?sid=081fc77923200cd6b61de25ebc9ab484 |
|
| SITENAME | Type: String Site name. |
phpBB 3.0.x Styles Demo Board |
|
| SITE_DESCRIPTION | Type: String Site description. |
This is an inactive board to showcase the styles in our database. |
|
| SITE_LOGO_IMG | Type: Image Board logo. |
<img src="./styles/prosilver/imageset/site_logo.gif" width="139" height="52" alt="" title="" /> |
http://www.phpbb.com/community/styles/prosilver/imageset/site_logo.gif |
| S_AUTOLOGIN_ENABLED | Type: Boolean Returns true if autologin is enabled. |
1 |
|
| S_BOARD_DISABLED | Type: Boolean Returns true if the board is disabled. |
0 |
|
| S_CONTENT_DIRECTION | Type: String Language direction -- ltr or rtl. |
ltr |
|
| S_CONTENT_ENCODING | Type: String Content encoding. |
UTF-8 |
|
| S_CONTENT_FLOW_BEGIN | Type: String Beginning of language direction (left to right in this case). |
left |
|
| S_CONTENT_FLOW_END | Type: String End of language direction (left to right in this case). |
right |
|
| S_DISPLAY_MEMBERLIST | Type: Boolean Returns true if the user has access to the member list. |
1 |
|
| S_DISPLAY_ONLINE_LIST | Type: Boolean Returns true if the "Who is online" feature is enabled. |
1 |
|
| S_DISPLAY_PM | Type: Boolean Returns true if the PM system is enabled, the user is registered and is allowed to read or send private messages. |
1 |
|
| S_DISPLAY_SEARCH | Type: Boolean Returns true if the user has permission to use the search system. |
1 |
|
| S_ENABLE_FEEDS | Type: Boolean Returns true if the ATOM feeds feature is enabled. |
1 |
|
| S_ENABLE_FEEDS_FORUMS | Type: Boolean Returns true if per-forum feeds are enabled. |
0 |
|
| S_ENABLE_FEEDS_NEWS | Type: Boolean Returns true if the news feed is enabled. |
0 |
|
| S_ENABLE_FEEDS_OVERALL | Type: Boolean Returns true if the board-wide feed is enabled. |
1 |
|
| S_ENABLE_FEEDS_TOPICS | Type: Boolean Returns true if per-topic feeds are enabled. |
1 |
|
| S_ENABLE_FEEDS_TOPICS_ACTIVE | Type: Boolean Returns true if the active topics feed is enabled. |
1 |
|
| S_FORUM_ID | Type: Integer Forum ID. |
0 |
|
| S_IS_BOT | Type: Boolean Returns true if the current user is a bot. |
0 |
|
| S_LOAD_UNREADS | Type: Boolean Returns true if searching for unread posts is enabled, and the user is registered or read/unread status storage is enabled for guests. |
1 |
|
| S_LOGIN_ACTION | Type: URL Login form action. |
./ucp.php?mode=login |
|
| S_LOGIN_REDIRECT | Type: String Login form redirect. |
<input type="hidden" name="redirect" value="./index.php?" /> |
|
| S_NEW_PM | Type: Boolean Returns true if the current user has new private messages. Private messages are considered "new" until the user views his inbox. |
0 |
|
| S_REGISTERED_USER | Type: Boolean Returns true if the user is registered. |
1 |
|
| S_REGISTER_ENABLED | Type: Boolean Returns true if registration is enabled. |
1 |
|
| S_TIMEZONE | Type: Language string User's time zone. The guest time zone is defined by the anonymous user's settings. |
All times are UTC |
|
| S_TOPIC_ID | Type: Integer Topic ID. |
0 |
|
| S_USERNAME | Type: String Current user's username. |
x14 |
|
| S_USER_BROWSER | Type: String Current user's browser agent. |
Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.2.13) Gecko/20101203 Firefox/3.6.13 |
|
| S_USER_LANG | Type: String Current user's board language. |
en-gb |
|
| S_USER_LOGGED_IN | Type: Boolean Returns true if the current user is logged in. |
1 |
|
| S_USER_NEW | Type: Boolean Returns true if the current user was registered while having the Set Newly Registered Users group to default setting enabled, New member post limit set to a number greater than 0 (settings do not apply to users retroactively), and user is still in the Newly registered users group. |
0 |
|
| S_USER_NEW_PRIVMSG | Type: Boolean Total number of new private messages. Private messages are considered "new" until the user views his inbox. |
1 |
|
| S_USER_PM_POPUP | Type: Boolean Returns true if the user prefers a window to pop up when a new private message is received. |
1 |
|
| S_USER_UNREAD_PRIVMSG | Type: Integer Total number of unread private messages. |
3 |
|
| TOTAL_USERS_ONLINE | Type: Language string Current number of registered users and guests online. |
In total there is <strong>1</strong> user online :: 1 registered, 0 hidden and 0 guests |
In total there is 1 user online :: 1 registered, 0 hidden and 0 guests |
| TRANSLATION_INFO | Type: Language string Translation info. |
Traduction réalisée par <a href="http://mael.soucaze.com/">Maël Soucaze</a> © 2010 <a href="http://www.phpbb.fr/">phpBB.fr</a> |
Traduction réalisée par Maël Soucaze © 2010 phpBB.fr |
| T_AVATAR | Type: String Uploaded avatars directory. |
images/avatars/upload |
|
| T_AVATAR_GALLERY | Type: String Avatar gallery directory. |
images/avatars/gallery |
|
| T_AVATAR_GALLERY_PATH | Type: URL Path to the avatar gallery directory. |
./images/avatars/gallery/ |
|
| T_AVATAR_PATH | Type: URL Path to the uploaded avatars directory. |
./images/avatars/upload/ |
|
| T_ICONS | Type: String Topic icons directory. |
images/icons |
|
| T_ICONS_PATH | Type: URL Path to the topic icons directory. |
./images/icons/ |
|
| T_IMAGES | Type: String Images directory. |
images |
|
| T_IMAGESET_LANG_NAME | Type: String Language imageset directory. |
en |
|
| T_IMAGESET_LANG_PATH | Type: URL Path to the language imageset directory for the imageset currently in use. |
./styles/prosilver/imageset/en |
|
| T_IMAGESET_NAME | Type: String Parent directory for the imageset currently in use. |
prosilver |
|
| T_IMAGESET_PATH | Type: URL Path to the imageset directory for the imageset currently in use. |
./styles/prosilver/imageset |
|
| T_IMAGES_PATH | Type: URL Path to the board's images directory. |
./images/ |
|
| T_RANKS | Type: String Ranks directory. |
images/ranks |
|
| T_RANKS_PATH | Type: URL Path to the ranks directory. |
./images/ranks/ |
|
| T_SMILIES | Type: String Smilies directory. |
images/smilies |
|
| T_SMILIES_PATH | Type: URL Path to the smilies directory. |
./images/smilies/ |
|
| T_STYLESHEET_LINK | Type: URL Stylesheet link. |
./style.php?id=1&=en |
|
| T_STYLESHEET_NAME | Type: String Theme currently in use. |
prosilver |
|
| T_SUPER_TEMPLATE_NAME | Type: String Parent directory for the template from which the current template in use is inheriting from. |
prosilver |
|
| T_SUPER_TEMPLATE_PATH | Type: URL Path to the template directory from which the current template in use is inheriting from. |
./styles/prosilver/template |
|
| T_TEMPLATE_NAME | Type: String Parent directory for the template currently in use. |
prosilver |
|
| T_TEMPLATE_PATH | Type: URL Path to the directory for the template currently in use. |
./styles/prosilver/template |
|
| T_THEME_NAME | Type: String Parent directory for the theme currently in use. |
prosilver |
|
| T_THEME_PATH | Type: URL Path to the directory for the theme currently in use. |
./styles/prosilver/theme |
|
| T_UPLOAD | Type: String Attachment storage directory. |
files |
|
| T_UPLOAD_PATH | Type: URL Path to the attachment storage directory. |
./files/ |
|
| UA_POPUP_PM | Type: URL Private message notification pop-up window URL with single quotes, double quotes and backslashes escaped. |
./ucp.php?i=pm&mode=popup |
|
| U_ACP | Type: URL View the Administration Control Panel. |
./adm/index.php?sid=ede34833a00079ee99c6d39d36877d68 |
|
| U_DELETE_COOKIES | Type: URL Delete all board cookies. |
./ucp.php?mode=delete_cookies |
|
| U_FAQ | Type: URL Frequently Asked Questions. |
./faq.php |
|
| U_FEED | Type: URL View the board's ATOM feed. |
http://localhost/phpBB3/feed.php |
|
| U_INDEX | Type: URL Board index page. |
./index.php |
|
| U_LOGIN_LOGOUT | Type: URL Login or Logout. |
./ucp.php?mode=logout&sid=ede34833a00079ee99c6d39d36877d68 |
|
| U_MEMBERLIST | Type: URL Member list. |
./memberlist.php |
|
| U_MODCP | Type: URL Main page of the Moderator Control Panel. |
./mcp.php?sid=ede34833a00079ee99c6d39d36877d68 |
|
| U_POPUP_PM | Type: URL Private message notification pop-up window URL. |
./ucp.php?i=pm&mode=popup |
|
| U_PRIVACY | Type: URL Privacy policy. |
./ucp.php?mode=privacy |
|
| U_PRIVATEMSGS | Type: URL Private message inbox folder. |
./ucp.php?i=pm&folder=inbox |
|
| U_PROFILE | Type: URL User Control Panel. |
./ucp.php |
|
| U_REGISTER | Type: URL Board registration page. |
./ucp.php?mode=register |
|
| U_RESTORE_PERMISSIONS | Type: URL Restore own permissions after testing another user's. |
||
| U_RETURN_INBOX | Type: URL Private message inbox folder. |
./ucp.php?i=pm&folder=inbox |
|
| U_SEARCH | Type: URL Advanced search. |
./search.php |
|
| U_SEARCH_ACTIVE_TOPICS | Type: URL Search active topics. |
./search.php?search_id=active_topics |
|
| U_SEARCH_NEW | Type: URL Search new posts since last visit. |
./search.php?search_id=newposts |
|
| U_SEARCH_SELF | Type: URL Search own posts. |
./search.php?search_id=egosearch |
|
| U_SEARCH_UNANSWERED | Type: URL Search unanswered posts. |
./search.php?search_id=unanswered |
|
| U_SEARCH_UNREAD | Type: URL Search unread posts. |
./search.php?search_id=unreadposts |
|
| U_TEAM | Type: URL The team page. |
./memberlist.php?mode=leaders |
|
| U_TERMS_USE | Type: URL Terms of use. |
./ucp.php?mode=terms |
|
| U_VIEWONLINE | Type: URL Detailed who is online page. |
./viewonline.php |
|
| _SID | Type: String User's session ID. A value will only be returned if the user does not have cookies enabled on his browser. See {SESSION_ID} if looking for a persistent return. |
081fc77923200cd6b61de25ebc9ab484 |
jumpbox_forums Block
| Variable | Description | Raw Code Example | Rendered Example |
|---|---|---|---|
| SELECTED | Type: Boolean Returns true if the forum is the current one being viewed. |
||
| S_IS_CAT | Type: Boolean Returns true if the forum is a category. |
1 |
|
| S_IS_LINK | Type: Boolean Returns true if the forum is a link. |
||
| S_IS_POST | Type: Boolean Returns true if the forum type allows posts -- meaning it's not a category or a link. |
||
| FORUM_ID | Type: Integer Forum ID. |
1 |
|
| FORUM_NAME | Type: String Forum name. |
Normal Category 1 |
|
| S_FIRST_ROW | Type: Boolean Returns true if the row is the first iteration of the block. |
1 |
|
| S_FORUM_COUNT | Type: String Current row iteration count. The first row is 0. |
2 |
|
| S_ROW_COUNT | Type: String Current row iteration count. The first row is 0. |
2 |
