phpBB

Development Wiki

Difference between revisions of "Add Events"

From phpBB Development Wiki

(Large Update)
Line 30: Line 30:
 
This gets the data from the hook. This won't need changing.
 
This gets the data from the hook. This won't need changing.
 
<br /><br />
 
<br /><br />
 +
 +
==Examples of ledges being added==
 +
[https://github.com/p/phpbb3/commit/15e4bdd67f69844b8f7c2387196fa3c54b66ff7c core.memberlist_profile_data ledge.]
 +
[https://github.com/p/phpbb3/commit/7e3cc2a333b4969f69622620cfd7b08ae595a219 Display forum ledges]
  
  
 
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 17:30, 12 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 you would use this code:

$vars = array('arrayname');
$event = new phpbb_event_data(compact($vars));
$phpbb_dispatcher->dispatch('identifer'$event);
extract($event->get_data_filtered($vars));

Let's dissect that code

Dissection

 $vars = array('arrayvariable');

This just defines the variable vars as the variable for the array.

 $event = new phpbb_event_data(compact($vars));

This won't need any changes and is beyond the scope of this article.

 $phpbb_dispatcher->dispatch('identifier', $event);

This just sets the identifier name (see below) and input parameter which is event as per the previous line. The identifer is 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. When its in a function you may need to add the following beforehand:

 global $phpbb_dispatcher



 extract($event->get_data_filtered($vars));

This gets the data from the hook. This won't need changing.

Examples of ledges being added

core.memberlist_profile_data ledge. Display forum ledges


Based on the blog article Explaining Hooks