[RFC|Implemented] page_header hook

[nickvergessen]

Name: hook_page_header
Rationale: The hook could be used to reduce edits for all mods, that need to load a language file globally or define a link in the overall_header.html
Placement: includes/functions.php
Input arguments: $page_title, $display_online_list, $item_id, $item
Output format: void
Output semantics: nothing
Related: A template-hook which you can use to add new links right next to the FAQ-Link: viewtopic.php?p=212631#p212631

[imkingdavid]

I agree with this, especially that last bit about adding to the FAQ, Members, etc link area.

[gn#36]

Yes, a lot of mods need to add a link to that menu.

[Jhong]

This is great.

However, I think for loading scripts and CSS files a more elegant solution is needed. At the minimum, two hooks, for "before other scripts" and "after other scripts", but even better would be a load_phpbb_script() function where you could specify priority and dependencies (see WordPress' enqueue_script() for an example).

There are other hooks I would need in the header too -- the order is important. These are the hooks I would currently need:

hook_dtd (override the DTD)
hook_meta (override the meta or add new values)
hook_scripts_before
hook_scripts_after

in addition to the hook to add a link with the FAQ, etc. links.

[Erik Frèrejean]

This hook should also be capable to be used as an replacement of page_header, for example if you're trying to build an third party application around phpBB and need system calls like login_box() these functions call the page header. If in that case the actual page header is called, there might arise various issues with the third party application. There are ways to hack your way around this currently but it would be much nicer if you can simply override the phpBB page header with your own code.

Proposed change:

Output format: void|bool
Output semantics: If the return format of the hook is "void" or "false", continue execution of the page header (as with the initial RFC). However if the return value is "true", do not execute the phpBB page header.

Code: Select all

function page_header(....)
{
   if ($phpbb_hook->result())
   {
      return;
   } 

[Jamika]

great suggestion!

[Steve©]

, i was going to post this suggestion ,I've already created this for my mods

Looking forward to 3.1

[Oleg]

I have this ledge in ledges-2: https://github.com/p/phpbb3/compare/dev ... 2Fledges-2 for my trivial css extension.

Input arguments: $page_title, $display_online_list, $item_id, $item

Template ledges do not have arguments, if they are needed this needs to be discussed somewhere.

This is great.

However, I think for loading scripts and CSS files a more elegant solution is needed. At the minimum, two hooks, for "before other scripts" and "after other scripts", but even better would be a load_phpbb_script() function where you could specify priority and dependencies (see WordPress' enqueue_script() for an example).

What you described for script loading is a good idea but it's off topic here.

There are other hooks I would need in the header too -- the order is important. These are the hooks I would currently need:

hook_dtd (override the DTD)

What would you need this for? DTD is defined by the style.

hook_meta (override the meta or add new values)

Overriding meta would be a different ledge, adding meta you can do with the generic header ledge.

hook_scripts_before
hook_scripts_after

Before and after what?

in addition to the hook to add a link with the FAQ, etc. links.

Probably a different topic for these as well.

This hook should also be capable to be used as an replacement of page_header, for example if you're trying to build an third party application around phpBB and need system calls like login_box() these functions call the page header. If in that case the actual page header is called, there might arise various issues with the third party application. There are ways to hack your way around this currently but it would be much nicer if you can simply override the phpBB page header with your own code.

This would be a different ledge.

[nickvergessen]

Input arguments: $page_title, $display_online_list, $item_id, $item

Template ledges do not have arguments, if they are needed this needs to be discussed somewhere.

This topic is not about template hooks

...
Placement: includes/functions.php
...
Related: A template-hook which you can use to add new links right next to the FAQ-Link: viewtopic.php?p=212631#p212631

[MichaelC]

https://github.com/p/phpbb3/commit/3498 ... 5d4ab7bad8 implements this and includes an override.