diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2012-08-05 16:42:46 +0200 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2012-08-05 16:42:46 +0200 |
| commit | 1f9b23e721008ca2903b9b4e79008867554eddf4 (patch) | |
| tree | dcddcf36f24be339d7443c187b364075e3f71da5 /phpBB/includes/functions.php | |
| parent | 171c07a0847f695a1c8e2f1f35784c453c47546a (diff) | |
| download | forums-1f9b23e721008ca2903b9b4e79008867554eddf4.tar forums-1f9b23e721008ca2903b9b4e79008867554eddf4.tar.gz forums-1f9b23e721008ca2903b9b4e79008867554eddf4.tar.bz2 forums-1f9b23e721008ca2903b9b4e79008867554eddf4.tar.xz forums-1f9b23e721008ca2903b9b4e79008867554eddf4.zip | |
[feature/php-events] Add docs for core.page_header
PHPBB3-9550
Diffstat (limited to 'phpBB/includes/functions.php')
| -rw-r--r-- | phpBB/includes/functions.php | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php index 442b125657..e39d5ee13e 100644 --- a/phpBB/includes/functions.php +++ b/phpBB/includes/functions.php @@ -4756,6 +4756,20 @@ function page_header($page_title = '', $display_online_list = true, $item_id = 0 // A listener can set this variable to `true` when it overrides this function $page_header_override = false; + /** + * Execute code and/or overwrite page_header() + * + * @event core.page_header + * @var string page_title Page title + * @var bool display_online_list Do we display online users list + * @var string item Restrict online users to a certain + * session item, e.g. forum for + * session_forum_id + * @var int item_id Restrict online users to item id + * @var bool page_header_override Shall we return instead of running + * the rest of page_header() + * @since 3.1-A1 + */ $vars = array('page_title', 'display_online_list', 'item_id', 'item', 'page_header_override'); extract($phpbb_dispatcher->trigger_event('core.page_header', compact($vars))); |