aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/docs/hook_system.html
diff options
context:
space:
mode:
authorMeik Sievertsen <acydburn@phpbb.com>2009-08-17 14:42:27 +0000
committerMeik Sievertsen <acydburn@phpbb.com>2009-08-17 14:42:27 +0000
commitfe01a43d453f81e4c6229eed2d40e2281a7dcffa (patch)
tree798cdf35223223ca55997902d587fad8fe762f73 /phpBB/docs/hook_system.html
parent6262263aefe4857d1c7af3ee68ed7c6a1e91e196 (diff)
downloadforums-fe01a43d453f81e4c6229eed2d40e2281a7dcffa.tar
forums-fe01a43d453f81e4c6229eed2d40e2281a7dcffa.tar.gz
forums-fe01a43d453f81e4c6229eed2d40e2281a7dcffa.tar.bz2
forums-fe01a43d453f81e4c6229eed2d40e2281a7dcffa.tar.xz
forums-fe01a43d453f81e4c6229eed2d40e2281a7dcffa.zip
Added section about special constants able to be used.
git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@10007 89ea8834-ac86-4346-8a33-228a782c2dd0
Diffstat (limited to 'phpBB/docs/hook_system.html')
-rw-r--r--phpBB/docs/hook_system.html48
1 files changed, 38 insertions, 10 deletions
diff --git a/phpBB/docs/hook_system.html b/phpBB/docs/hook_system.html
index 565e0096fc..b23ebab869 100644
--- a/phpBB/docs/hook_system.html
+++ b/phpBB/docs/hook_system.html
@@ -104,14 +104,14 @@ h3 {
border-top: 1px solid #ccc;
}
-code {
- color: #006600;
- font-weight: normal;
- font-family: 'Courier New', monospace;
- border-color: #D1D7DC;
- border-width: 1px;
- border-style: solid;
- background-color: #FAFAFA;
+code {
+ color: #006600;
+ font-weight: normal;
+ font-family: 'Courier New', monospace;
+ border-color: #D1D7DC;
+ border-width: 1px;
+ border-style: solid;
+ background-color: #FAFAFA;
}
#wrap {
@@ -387,8 +387,36 @@ PHPBB_MSG_HANDLER (overwrite message handler)
PHPBB_DB_NEW_LINK (overwrite new_link parameter for sql_connect)
PHPBB_ROOT_PATH (overwrite $phpbb_root_path)
PHPBB_ADMIN_PATH (overwrite $phpbb_admin_path)
+PHPBB_USE_BOARD_URL_PATH (use generate_board_url() for image paths instead of $phpbb_root_path)
</pre></div>
+<p>If the <code>PHPBB_USE_BOARD_URL_PATH</code> constant is set to true, phpBB uses generate_board_url() (this will return the boards url with the script path included) on all instances where web-accessible images are loaded. The exact locations are:</p>
+
+<ul>
+ <li>/includes/session.php - user::img()</li>
+ <li>/includes/functions_content.php - smiley_text()</li>
+</ul>
+
+<p>Path locations for the following template variables are affected by this too:</p>
+
+<ul>
+ <li>{T_THEME_PATH} - styles/xxx/theme</li>
+ <li>{T_TEMPLATE_PATH} - styles/xxx/template</li>
+ <li>{T_SUPER_TEMPLATE_PATH} - styles/xxx/template</li>
+ <li>{T_IMAGESET_PATH} - styles/xxx/imageset</li>
+ <li>{T_IMAGESET_LANG_PATH} - styles/xxx/imageset/yy</li>
+ <li>{T_IMAGES_PATH} - images/</li>
+ <li>{T_SMILIES_PATH} - $config['smilies_path']/</li>
+ <li>{T_AVATAR_PATH} - $config['avatar_path']/</li>
+ <li>{T_AVATAR_GALLERY_PATH} - $config['avatar_gallery_path']/</li>
+ <li>{T_ICONS_PATH} - $config['icons_path']/</li>
+ <li>{T_RANKS_PATH} - $config['ranks_path']/</li>
+ <li>{T_UPLOAD_PATH} - $config['upload_path']/</li>
+ <li>{T_STYLESHEET_LINK} - styles/xxx/theme/stylesheet.css (or link to style.php if css is parsed dynamically)</li>
+ <li>New template variable {BOARD_URL} for the board url + script path.</li>
+</ul>
+
+
</div>
<div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
@@ -616,7 +644,7 @@ echo $second_object-&gt;hook_me('first', 'second') . '&lt;br /&gt;';
<div class="codebox"><pre>
not hooked
-hooked
+hooked
</pre></div>
<p>A different possibility would be using a function variable (which could be left out on passing the function variables to the hook):</p>
@@ -670,7 +698,7 @@ echo $second_object-&gt;hook_me('first', 'second') . '&lt;br /&gt;';
<div class="codebox"><pre>
not hooked
-hooked
+hooked
</pre></div>
</div>