[Readme] [Info] How to request an event [OBSOLETE]

[MichaelC]

NOTICE: These procedures have been replaced by the procedures here:
https://area51.phpbb.com/phpBB/viewtopi ... 26&t=47511


Events are hook locations/ledges. For more information about them and how to add them please take a look at the wiki events and listeners category.

Please note all explanations in this post should include:

• At least 1 use-case
• Preferably an extension/MOD that exists that might make use of it (optional)
• What it could be used for
• Why should it have those parameters and that location

How to request a template event:
Post a topic with the title [Template] Identifier

Then it should include the following information:

Code: Select all

Identifier:
Prosilver Location (if applicable):
Subsilver Location (if applicable):
Explanation:

The identifier should be formatted as prosilver location file followed by a descriptor. For e.g.
overall_footer_copyright
If it is only in subsilver then the subsilver location should be used (as hooks don't have to be in both styles).

How to request an acp template event:
Post a topic with the title [ACP Template] Identifier

Then it should include the following information:

Code: Select all

Identifier:
Location:
Explanation:

How to request a core event:
Post a topic with the title [PHP] Identifier

Then it should include the following information:

Code: Select all

Identifer:
Location:
Parameters:
Explanation:

The identifier should be formatted as a general descriptor (preferably the function if its in one; possibly followed by a descriptor if there are more than one event in the function). All core events are prefixed by core. For e.g.
core.viewtopic_postrow for postrow in viewtopic.php

Review Process:
After being posted it will be reviewed to check it would work ok and then someone will either implement it for you or you can submit a patch for it.

The patch will then be reviewed by somone who cannot be the original suggester or implementer. It will then be merged by a developer.

Adding events:
You can add the events yourself (via submitting a PR) or by making a topic and then someone might come along and do it for you.
All events should be made against this ticket: http://tracker.phpbb.com/browse/PHPBB3-9550
Once a PR is submitted it will be reviewed and merged by the development team / events reviewers.

[MattF]

Events have been merged. Since it appears as though Event Requests in this forum have been somewhat ignored, can we still make PRs for events we want to add ourselves, and if so, do we still do it to your repo, or directly to the phpBB3.1-dev repo?

[imkingdavid]

You are correct; new events should now be added in a Pull Request of a branch based against the "develop" branch of the main phpbb3 repository. The ticket you should use is PHPBB3-9550.

[MattF]

Thanks King!

[Nicofuma]

Some new details: When you create an event request here, it's important to create the associated ticket in the tracker and to add a link, in the description, to the topic in this forum and a link to the ticket in the first post of the topic.