phpBB

Development Wiki

Add Events

From phpBB Development Wiki

Revision as of 17:33, 12 March 2012 by Michaelc (Talk | contribs)

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.

Core Ledges List

If you add a ledge to the core you need to ensure you add it to the ledges list to ensure it remains a comprehensive and exhaustive list.

Requested ledges can also be added to the list and they will be added at some point to the phpBB repository.

You can view and edit the ledges list page here

Examples of ledges being added


Based on the blog article Explaining Hooks