phpBB

Development Wiki

Difference between revisions of "Add Events"

From phpBB Development Wiki

(So what are ledges)
(How to add a ledge)
Line 18: Line 18:
 
<pre class="narrow-codebox"> <nowiki>$input_param</nowiki></pre>
 
<pre class="narrow-codebox"> <nowiki>$input_param</nowiki></pre>
 
This is where the input parameters go. This will either be a single variable or an array of variables, depending on the ledge onto which you are hooking.
 
This is where the input parameters go. This will either be a single variable or an array of variables, depending on the ledge onto which you are hooking.
 +
 +
When required you will also need to add:
 +
<pre class="narrow-codebox"> <nowiki>global $phpbb_dispatcher</nowiki></pre>
  
 
Based on the blog article [http://blog.phpbb.com/2010/10/09/explaining-hooks/ Explaining Hooks]
 
Based on the blog article [http://blog.phpbb.com/2010/10/09/explaining-hooks/ Explaining Hooks]
 
[[Category:Ledges and Hooks]]
 
[[Category:Ledges and Hooks]]

Revision as of 12:24, 11 March 2012

What are ledges?

A ledge is a hook location. When an extension wishes to hook its functionality into the phpBB core at a certain point, it can do so only at available hook locations, or ledges. For more information, see the wiki article for hooks.

How to add a ledge

You would add a ledge like so:

 $phpbb_dispatcher->dispatch('identifer', $input_param);  

Let's dissect that code

 $phpbb_dispatcher

This is the phpbb_dispatcher object, which is automatically loaded with the page. This object registers the hook containers of found within hook files (in the hooks/*.php directory) with the hooks controller.

 dispatch

This method adds a ledge.

 identifer

This is where you enter the name for the hook. If its in the core it should be prefixed by "core." but if its in an extension you should prefix it with a unique string related to your extension to prevent clashes with other extensions.

 $input_param

This is where the input parameters go. This will either be a single variable or an array of variables, depending on the ledge onto which you are hooking.

When required you will also need to add:

 global $phpbb_dispatcher

Based on the blog article Explaining Hooks