aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/functions_acp.php
diff options
context:
space:
mode:
authorJoas Schilling <nickvergessen@gmx.de>2012-08-05 21:17:29 +0200
committerJoas Schilling <nickvergessen@gmx.de>2012-08-05 21:20:14 +0200
commit296ab5c168dfb324821c0ba965028be690745eb3 (patch)
tree8db719074622fb53fe1671b86215d1013c7c56b9 /phpBB/includes/functions_acp.php
parente926ec9934348c1e2e556782edbb47630c58facc (diff)
downloadforums-296ab5c168dfb324821c0ba965028be690745eb3.tar
forums-296ab5c168dfb324821c0ba965028be690745eb3.tar.gz
forums-296ab5c168dfb324821c0ba965028be690745eb3.tar.bz2
forums-296ab5c168dfb324821c0ba965028be690745eb3.tar.xz
forums-296ab5c168dfb324821c0ba965028be690745eb3.zip
[feature/php-events] Add docs for core.adm_page_header
PHPBB3-9550
Diffstat (limited to 'phpBB/includes/functions_acp.php')
-rw-r--r--phpBB/includes/functions_acp.php10
1 files changed, 10 insertions, 0 deletions
diff --git a/phpBB/includes/functions_acp.php b/phpBB/includes/functions_acp.php
index f59c8cd4c6..19f2873208 100644
--- a/phpBB/includes/functions_acp.php
+++ b/phpBB/includes/functions_acp.php
@@ -34,8 +34,18 @@ function adm_page_header($page_title)
// A listener can set this variable to `true` when it overrides this function
$adm_page_header_override = false;
+ /**
+ * Execute code and/or overwrite adm_page_header()
+ *
+ * @event core.adm_page_header
+ * @var string page_title Page title
+ * @var bool adm_page_header_override Shall we return instead of
+ * running the rest of adm_page_header()
+ * @since 3.1-A1
+ */
$vars = array('page_title', 'adm_page_header_override');
extract($phpbb_dispatcher->trigger_event('core.adm_page_header', compact($vars)));
+
if ($adm_page_header_override)
{
return;