PageRenderTime 47ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/development/extension_hooks/module/forum/index.html

https://bitbucket.org/ellislab/expressionengine-user-guide/
HTML | 362 lines | 268 code | 93 blank | 1 comment | 0 complexity | 1587cc7bfe1f971df85ff8eda3a06f17 MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
    2. 

  2. 

  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
    4. 

  4. <head>
    5. 

  5. 	<meta http-equiv="content-type" content="text/html; charset=utf-8" />
    6. 

  6. 

  7. 	<title>Forum Module Extension Hooks &#8211; ExpressionEngine Developer Documentation</title>
    8. 

  8. 

  9. 	<meta name="MSSmartTagsPreventParsing" content="TRUE" />
    10. 

  10. 	<link rel="contents" href="../../index.html" />
    11. 

  11. 	<style type="text/css" media="screen,print">@import url(../../../../docs.css);</style>
    12. 

  12. 

  13. </head>
    14. 

  14. 

  15. <body>
    16. 

  16. <div><a name="top"></a></div>
    17. 

  17. 

  18. 

  19. <div id="header">
    20. 

  20. <table cellpadding="0" cellspacing="0" border="0" style="width:100%;"><tr>
    21. 

  21. <td class="docheading" style="width:300px;"><a href="../../../../index.html"><img src="../../../../images/user_guide.gif" width="231" height="24" alt="ExpressionEngine User Guide" /></a></td>
    22. 

  22. <td class="searchbox"><form method="get" action="http://www.google.com/search" class="searchbox"><div>Search&nbsp;&nbsp;<input type="text" class="input" name="q" id="q" size="31" maxlength="255" value="" /><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="expressionengine.com/docs/" />&nbsp;<input type="submit" class="submit" name="sa" value="Search" /></div></form></td>
    23. 

  23. </tr>
    24. 

  24. </table>
    25. 

  25. </div>
    26. 

  26. 

  27. 

  28. <div id="navlinks">
    29. 

  29. <a href="../../../../index.html">Table of Contents</a> &gt;
    30. 

  30. <a href="../../../index.html">Development</a> &gt;
    31. 

  31. <a href="../../index.html">Extension Hooks</a> &gt;
    32. 

  32. <strong>Forum Module Extension Hooks</strong>
    33. 

  33. </div>
    34. 

  34. 

  35. 

  36. <div id="content">
    37. 

  37. <h1>Forum Module Extension Hooks</h1>
    38. 

  38. 

  39. 	<p>In the menu below you will find links to details about available extension hooks in the Forum module (mod.forum_core.php).</p>
    40. 

  40. 

  41. 	<ul class="toc">
    42. 

  42. 		<li><a href="#forum_submission_form_start">forum_submission_form_start</a></li>
    43. 

  43. 		<li><a href="#forum_submission_form_end">forum_submission_form_end</a></li>
    44. 

  44. 		<li><a href="#forum_submission_page">forum_submission_page</a></li>
    45. 

  45. 		<li><a href="#forum_submit_post_start">forum_submit_post_start</a></li>
    46. 

  46. 		<li><a href="#forum_submit_post_end">forum_submit_post_end</a></li>
    47. 

  47. 		<li><a href="#forum_threads_template">forum_threads_template</a></li>
    48. 

  48. 		<li><a href="#forum_thread_rows_absolute_end">forum_thread_rows_absolute_end</a></li>
    49. 

  49. 		<li><a href="#forum_thread_rows_loop_start">forum_thread_rows_loop_start</a></li>
    50. 

  50. 		<li><a href="#forum_thread_rows_loop_end">forum_thread_rows_loop_end</a></li>
    51. 

  51. 		<li><a href="#forum_thread_rows_start">forum_thread_rows_start</a></li>
    52. 

  52. 		<li><a href="#forum_topics_absolute_end">forum_topics_absolute_end</a></li>
    53. 

  53. 		<li><a href="#forum_topics_loop_start">forum_topics_loop_start</a></li>
    54. 

  54. 		<li><a href="#forum_topics_loop_end">forum_topics_loop_end</a></li>
    55. 

  55. 		<li><a href="#forum_topics_start">forum_topics_start</a></li>
    56. 

  56. 		<li><a href="#main_forum_table_rows_template">main_forum_table_rows_template</a></li>
    57. 

  57. 	</ul>
    58. 

  58. 

  59. 	<h3><small>Added in v1.4.0</small><a name="forum_submission_form_start">forum_submission_form_start</a></h3>
    60. 

  60. 

  61. 		<p>Allows rewrite or modify of Submission form template before processing</p>
    62. 

  62. 

  63. 		<code><samp>$str</samp> = $this->extensions->universal_call('<strong>forum_submission_form_start</strong>', <var>$this</var>, <var>$str</var>);
    64. 

  64. if ($this->extensions->end_script === TRUE) return $str;</code>
    65. 

  65. 

  66. 		<dl>
    67. 

  67. 			<dt>$this</dt>
    68. 

  68. 			<dd>The current Forum Core object</dd>
    69. 

  69. 			<dt>$str</dt>
    70. 

  70. 			<dd>Submission form template</dd>
    71. 

  71. 			<dt><em>Return value</em></dt>
    72. 

  72. 			<dd>String</dd>
    73. 

  73. 		</dl>
    74. 

  74. 

  75. 	<h3><small>Added in v1.4.0</small><a name="forum_submission_form_end">forum_submission_form_end</a></h3>
    76. 

  76. 

  77. 		<p>Final chance to modify the submission form before it is displayed</p>
    78. 

  78. 

  79. 		<code><samp>$str</samp> = $this->extensions->universal_call('<strong>forum_submission_form_end</strong>', <var>$this</var>, <var>$str</var>);
    80. 

  80. if ($this->extensions->end_script === TRUE) return $str;</code>
    81. 

  81. 

  82. 		<dl>
    83. 

  83. 			<dt>$this</dt>
    84. 

  84. 			<dd>The current Forum Core object</dd>
    85. 

  85. 			<dt>$str</dt>
    86. 

  86. 			<dd>Submission form template</dd>
    87. 

  87. 			<dt><em>Return value</em></dt>
    88. 

  88. 			<dd>String</dd>
    89. 

  89. 		</dl>
    90. 

  90. 

  91. 

  92. 	<h3><small>Added in v1.4.0</small><a name="forum_submission_page">forum_submission_page</a></h3>
    93. 

  93. 

  94. 		<p>
    95. 

  95. 			- Allows usurping of forum submission forms<br />
    96. 

  96. 			- More error checking and permissions, too
    97. 

  97. 		</p>
    98. 

  98. 

  99. 		<code><samp>$edata</samp> = $this->extensions->universal_call('<strong>forum_submission_page</strong>', <var>$this</var>, <var>$type</var>);
    100. 

  100. if ($this->extensions->end_script === TRUE) return $edata;</code>
    101. 

  101. 

  102. 		<dl>
    103. 

  103. 			<dt>$this</dt>
    104. 

  104. 			<dd>The current Forum Core object</dd>
    105. 

  105. 			<dt>$type</dt>
    106. 

  106. 			<dd>new_topic, edit_topic, new_reply, edit_reply</dd>
    107. 

  107. 			<dt><em>Return value</em></dt>
    108. 

  108. 			<dd>void</dd>
    109. 

  109. 		</dl>
    110. 

  110. 

  111. 

  112. 	<h3><small>Added in v1.4.0</small><a name="forum_submit_post_start">forum_submit_post_start</a></h3>
    113. 

  113. 

  114. 		<p>Allows usurping of forum submission routine or possible adding more checks and permissions</p>
    115. 

  115. 

  116. 		<code><samp>$edata</samp> = $this->extensions->universal_call('<strong>forum_submit_post_start</strong>', <var>$this</var>);
    117. 

  117. if ($this->extensions->end_script === TRUE) return $edata;</code>
    118. 

  118. 

  119. 		<dl>
    120. 

  120. 			<dt>$this</dt>
    121. 

  121. 			<dd>The current Forum Core object</dd>
    122. 

  122. 			<dt><em>Return value</em></dt>
    123. 

  123. 			<dd>void</dd>
    124. 

  124. 		</dl>
    125. 

  125. 				
    126. 

  126. 

  127. 	<h3><small>Added in v1.5.2</small><a name="forum_submit_post_end">forum_submit_post_end</a></h3>
    128. 

  128. 

  129. 		<p>Do more processing after the post is submitted.</p>
    130. 

  130. 

  131. 		<code><samp>$edata</samp> = $this->extensions->universal_call('<strong>forum_submit_post_end</strong>', <var>$this</var>, <var>$data</var>);
    132. 

  132. if ($this->extensions->end_script === TRUE) return $edata;</code>
    133. 

  133. 

  134. 		<dl>
    135. 

  135. 			<dt>$this</dt>
    136. 

  136. 			<dd>The current Forum Core object</dd>
    137. 

  137. 			<dt>$data</dt>
    138. 

  138. 			<dd>the forum post data array</dd>
    139. 

  139. 			<dt><em>Return value</em></dt>
    140. 

  140. 			<dd>void</dd>
    141. 

  141. 		</dl>
    142. 

  142. 		
    143. 

  143. 		<h4>Additional Notes</h4>
    144. 

  144. 		<p>Note that user notifications have not been sent at this point. The $data array was added in build 20080626</p>
    145. 

  145. 

  146. 

  147. 

  148. 	<h3><small>Added in v1.4.0</small><a name="forum_threads_template">forum_threads_template</a></h3>
    149. 

  149. 

  150. 		<p>Allows modifying of the Threads display template before it is processed</p>
    151. 

  151. 

  152. 		<code><samp>$str</samp> = $this->extensions->universal_call('<strong>forum_threads_template</strong>', <var>$this</var>, <var>$str</var>, <var>$tquery</var>);
    153. 

  153. if ($this->extensions->end_script === TRUE) return $str;</code>
    154. 

  154. 

  155. 		<dl>
    156. 

  156. 			<dt>$this</dt>
    157. 

  157. 			<dd>The current Forum Core object</dd>
    158. 

  158. 			<dt>$str</dt>
    159. 

  159. 			<dd>The topics thread template</dd>
    160. 

  160. 			<dt>$tquery</dt>
    161. 

  161. 			<dd>The data for this thread</dd>
    162. 

  162. 			<dt><em>Return value</em></dt>
    163. 

  163. 			<dd>String</dd>
    164. 

  164. 		</dl>
    165. 

  165. 

  166. 

  167. 	<h3><small>Added in v1.5.1</small><a name="forum_thread_rows_absolute_end">forum_thread_rows_absolute_end</a></h3>
    168. 

  168. 

  169. 		<p>Take the processed thread rows and do what you wish</p>
    170. 

  170. 

  171. 		<code><samp>$thread_rows</samp> = $this->extensions->universal_call('<strong>forum_thread_rows_absolute_end</strong>', <var>$this</var>, <var>$data</var>, <var>$thread_rows</var>);
    172. 

  172. if ($this->extensions->end_script === TRUE) return $thread_rows;</code>
    173. 

  173. 

  174. 		<dl>
    175. 

  175. 			<dt>$this</dt>
    176. 

  176. 			<dd>The current Forum Core object</dd>
    177. 

  177. 			<dt>$data</dt>
    178. 

  178. 			<dd>Information about the current group of thread_rows (announcement, topic, all posts, etc.)</dd>
    179. 

  179. 			<dt>$thread_rows</dt>
    180. 

  180. 			<dd>The fully processed thread row template</dd>
    181. 

  181. 			<dt><em>Return value</em></dt>
    182. 

  182. 			<dd>String</dd>
    183. 

  183. 		</dl>
    184. 

  184. 

  185. 

  186. 	<h3><small>Added in v1.5.1</small><a name="forum_thread_rows_loop_start">forum_thread_rows_loop_start</a></h3>
    187. 

  187. 

  188. 		<p>Modify the thread row template and data before any processing takes place</p>
    189. 

  189. 

  190. 		<code><samp>$temp</samp> = $this->extensions->universal_call('<strong>forum_thread_rows_loop_start</strong>', <var>$this</var>, <var>$data</var>, <var>$row</var>, <var>$temp</var>);
    191. 

  191. if ($this->extensions->end_script === TRUE) return;</code>
    192. 

  192. 

  193. 		<dl>
    194. 

  194. 			<dt>$this</dt>
    195. 

  195. 			<dd>The current Forum Core object</dd>
    196. 

  196. 			<dt>$data</dt>
    197. 

  197. 			<dd>The data for all thread rows</dd>
    198. 

  198. 			<dt>$row</dt>
    199. 

  199. 			<dd>The data for this thread row (post)</dd>
    200. 

  200. 			<dt>$temp</dt>
    201. 

  201. 			<dd>The processed thread row</dd>
    202. 

  202. 			<dt><em>Return value</em></dt>
    203. 

  203. 			<dd>String</dd>
    204. 

  204. 		</dl>
    205. 

  205. 

  206. 

  207. 	<h3><small>Added in v1.5.1</small><a name="forum_thread_rows_loop_end">forum_thread_rows_loop_end</a></h3>
    208. 

  208. 

  209. 		<p>Modify the processed row before it is appended to the template output</p>
    210. 

  210. 

  211. 		<code><samp>$temp</samp> = $this->extensions->universal_call('<strong>forum_thread_rows_loop_end</strong>', <var>$this</var>, <var>$data</var>, <var>$row</var>, <var>$temp</var>);
    212. 

  212. if ($this->extensions->end_script === TRUE) return;</code>
    213. 

  213. 

  214. 		<dl>
    215. 

  215. 			<dt>$this</dt>
    216. 

  216. 			<dd>The current Forum Core object</dd>
    217. 

  217. 			<dt>$data</dt>
    218. 

  218. 			<dd>The data for all thread rows</dd>
    219. 

  219. 			<dt>$row</dt>
    220. 

  220. 			<dd>The data for this thread row (post)</dd>
    221. 

  221. 			<dt>$temp</dt>
    222. 

  222. 			<dd>The processed thread row</dd>
    223. 

  223. 			<dt><em>Return value</em></dt>
    224. 

  224. 			<dd>String</dd>
    225. 

  225. 		</dl>
    226. 

  226. 

  227. 

  228. 	<h3><small>Added in v1.4.0</small><a name="forum_thread_rows_start">forum_thread_rows_start</a></h3>
    229. 

  229. 

  230. 		<p>Allows modifying of the thread rows template</p>
    231. 

  231. 

  232. 		<code><samp>$template</samp> = $this->extensions->universal_call('<strong>forum_thread_rows_start</strong>', <var>$this</var>, <var>$template</var>, <var>$data</var>, <var>$is_announcement</var>, <var>$thread_review</var>);
    233. 

  233. if ($this->extensions->end_script === TRUE) return $template;</code>
    234. 

  234. 

  235. 		<dl>
    236. 

  236. 			<dt>$this</dt>
    237. 

  237. 			<dd>The current Forum Core object</dd>
    238. 

  238. 			<dt>$template</dt>
    239. 

  239. 			<dd>The topics thread row template</dd>
    240. 

  240. 			<dt>$data</dt>
    241. 

  241. 			<dd>The data for this thread row (post)</dd>
    242. 

  242. 			<dt>$is_announcement</dt>
    243. 

  243. 			<dd>TRUE/FALSE</dd>
    244. 

  244. 			<dt>$thread_review</dt>
    245. 

  245. 			<dd>TRUE/FALSE</dd>
    246. 

  246. 			<dt><em>Return value</em></dt>
    247. 

  247. 			<dd>String</dd>
    248. 

  248. 		</dl>
    249. 

  249. 

  250. 

  251. 	<h3><small>Added in v1.5.1</small><a name="forum_topics_absolute_end">forum_topics_absolute_end</a></h3>
    252. 

  252. 

  253. 		<p>Modify the finalized topics template and do what you wish</p>
    254. 

  254. 

  255. 		<code><samp>$str</samp> = $this->extensions->universal_call('<strong>forum_topics_absolute_end</strong>', <var>$this</var>, <var>$query->result</var>, <var>$str</var>);
    256. 

  256. if ($this->extensions->end_script === TRUE) return $str;</code>
    257. 

  257. 

  258. 		<dl>
    259. 

  259. 			<dt>$this</dt>
    260. 

  260. 			<dd>The current Forum Core object</dd>
    261. 

  261. 			<dt>$query->result</dt>
    262. 

  262. 			<dd>Array of all of the displayed topics</dd>
    263. 

  263. 			<dt>$str</dt>
    264. 

  264. 			<dd>The finalized topics template</dd>
    265. 

  265. 			<dt><em>Return value</em></dt>
    266. 

  266. 			<dd>String</dd>
    267. 

  267. 		</dl>
    268. 

  268. 

  269. 

  270. 	<h3><small>Added in v1.5.1</small><a name="forum_topics_loop_start">forum_topics_loop_start</a></h3>
    271. 

  271. 

  272. 		<p>Modify the topic row template and data before any processing takes place</p>
    273. 

  273. 

  274. 		<code><samp>$temp</samp> = $this->extensions->universal_call('<strong>forum_topics_loop_start</strong>', <var>$this</var>, <var>$query->result</var>, <var>$row</var>, <var>$temp</var>);
    275. 

  275. if ($this->extensions->end_script === TRUE) return;</code>
    276. 

  276. 

  277. 		<dl>
    278. 

  278. 			<dt>$this</dt>
    279. 

  279. 			<dd>The current Forum Core object</dd>
    280. 

  280. 			<dt>$query->result</dt>
    281. 

  281. 			<dd>Array of all of the topics</dd>
    282. 

  282. 			<dt>$row</dt>
    283. 

  283. 			<dd>The data for this topic</dd>
    284. 

  284. 			<dt>$temp</dt>
    285. 

  285. 			<dd>The yet-to-be-processed template</dd>
    286. 

  286. 			<dt><em>Return value</em></dt>
    287. 

  287. 			<dd>String</dd>
    288. 

  288. 		</dl>
    289. 

  289. 

  290. 

  291. 	<h3><small>Added in v1.5.1</small><a name="forum_topics_loop_end">forum_topics_loop_end</a></h3>
    292. 

  292. 

  293. 		<p>Modify the processed topic row before it is appended to the template output</p>
    294. 

  294. 

  295. 		<code><samp>$temp</samp> = $this->extensions->universal_call('<strong>forum_topics_loop_end</strong>', <var>$this</var>, <var>$query->result</var>, <var>$row</var>, <var>$temp</var>);
    296. 

  296. if ($this->extensions->end_script === TRUE) return;</code>
    297. 

  297. 

  298. 		<dl>
    299. 

  299. 			<dt>$this</dt>
    300. 

  300. 			<dd>The current Forum Core object</dd>
    301. 

  301. 			<dt>$query->result</dt>
    302. 

  302. 			<dd>Array of all of the topics</dd>
    303. 

  303. 			<dt>$row</dt>
    304. 

  304. 			<dd>The data for this topic</dd>
    305. 

  305. 			<dt>$temp</dt>
    306. 

  306. 			<dd>The yet-to-be-processed template</dd>
    307. 

  307. 			<dt><em>Return value</em></dt>
    308. 

  308. 			<dd>String</dd>
    309. 

  309. 		</dl>
    310. 

  310. 

  311. 

  312. 	<h3><small>Added in v1.4.0</small><a name="forum_topics_start">forum_topics_start</a></h3>
    313. 

  313. 

  314. 		<p>Allows modifying of the Topics display template before it is processed</p>
    315. 

  315. 

  316. 		<code><samp>$str</samp> = $this->extensions->universal_call('<strong>forum_topics_start</strong>', <var>$this</var>, <var>$str</var>);
    317. 

  317. if ($this->extensions->end_script === TRUE) return $str;</code>
    318. 

  318. 

  319. 		<dl>
    320. 

  320. 			<dt>$this</dt>
    321. 

  321. 			<dd>The current Forum Core object</dd>
    322. 

  322. 			<dt>$str</dt>
    323. 

  323. 			<dd>The topics template</dd>
    324. 

  324. 			<dt><em>Return value</em></dt>
    325. 

  325. 			<dd>String</dd>
    326. 

  326. 		</dl>
    327. 

  327. 

  328. 

  329. 	<h3><small>Added in v1.6.8</small><a name="main_forum_table_rows_template">main_forum_table_rows_template</a></h3>
    330. 

  330. 

  331. 		<p>Allows modifying of the forum_table_rows template</p>
    332. 

  332. 

  333. 		<code><samp>$table_rows</samp> = $this->extensions->universal_call('<strong>main_forum_table_rows_template</strong>', <var>$this</var>, <var>$query->result</var>, <var>$row</var>, <var>$temp</var>);
    334. 

  334. if ($this->extensions->end_script === TRUE) return $table_rows;</code>
    335. 

  335. 

  336. 		<dl>
    337. 

  337. 			<dt>$this</dt>
    338. 

  338. 			<dd>The current Forum Core object</dd>
    339. 

  339. 			<dt>$table_rows</dt>
    340. 

  340. 			<dd>The unparsed forum table rows template</dd>
    341. 

  341. 			<dt>$row</dt>
    342. 

  342. 			<dd>Array of data for the current row</dd>
    343. 

  343. 			<dt>$markers</dt>
    344. 

  344. 			<dd>Array of topic markers</dd>
    345. 

  345. 			<dt>$read_topics</dt>
    346. 

  346. 			<dd>Array of topics read by current visitor</dd>
    347. 

  347. 			<dt><em>Return value</em></dt>
    348. 

  348. 			<dd>Array</dd>
    349. 

  349. 		</dl>
    350. 

  350. 

  351. 

  352. </div><!-- content -->
    353. 

  353. <p class="center"><a href="#top">Top of Page</a></p>
    354. 

  354. 

  355. <!-- {user_guide_comments} -->
    356. 

  356. 

  357. <div id="footer">
    358. 

  358.   <address><a href="http://expressionengine.com/">ExpressionEngine</a> &#8211; Copyright &#169; 2002-2011 &#8211; <a href="http://ellislab.com/">EllisLab, Inc.</a></address>
    359. 

  359. </div>
    360. 

  360. 

  361. </body>
    362. 

  362. </html>
    363.