diff options
| author | David King <imkingdavid@gmail.com> | 2012-08-21 11:25:52 -0400 |
|---|---|---|
| committer | David King <imkingdavid@gmail.com> | 2012-08-21 11:25:52 -0400 |
| commit | 6c6b179dd4b239030891fcc3b72472fbf4f78bc9 (patch) | |
| tree | 4d362155248f435c797e5ceb3220c7e0759490f4 /phpBB | |
| parent | 008cf967ab176958126582b58941bd7649732315 (diff) | |
| download | forums-6c6b179dd4b239030891fcc3b72472fbf4f78bc9.tar forums-6c6b179dd4b239030891fcc3b72472fbf4f78bc9.tar.gz forums-6c6b179dd4b239030891fcc3b72472fbf4f78bc9.tar.bz2 forums-6c6b179dd4b239030891fcc3b72472fbf4f78bc9.tar.xz forums-6c6b179dd4b239030891fcc3b72472fbf4f78bc9.zip | |
[feature/add_events] Rename override to overwrite, made docs 79 chars/line
PHPBB3-9550
Diffstat (limited to 'phpBB')
| -rw-r--r-- | phpBB/includes/functions.php | 35 |
1 files changed, 18 insertions, 17 deletions
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php index 404288083b..9f1172e61e 100644 --- a/phpBB/includes/functions.php +++ b/phpBB/includes/functions.php @@ -2239,38 +2239,39 @@ function append_sid($url, $params = false, $is_amp = true, $session_id = false) $params = false; } - $append_sid_override = false; + $append_sid_overwrite = false; /** * This event can either supplement or override the append_sid() function * - * To override this function, the event must set $append_sid_override to + * To override this function, the event must set $append_sid_overwrite to * the new URL value, which will be returned following the event * * @event core.append_sid - * @var string url The url the session id needs to be - * appended to (can have params) - * @var mixed params String or array of additional url - * parameters - * @var bool is_amp Is url using & (true) or - * & (false) - * @var bool|string session_id Possibility to use a custom session - * id (string) instead of the global - * one (false) - * @var bool|string append_sid_override Overwrite function (string URL) - * or not (false) + * @var string url The url the session id needs + * to be appended to (can have + * params) + * @var mixed params String or array of additional + * url parameters + * @var bool is_amp Is url using & (true) or + * & (false) + * @var bool|string session_id Possibility to use a custom + * session id (string) instead of + * the global one (false) + * @var bool|string append_sid_overwrite Overwrite function (string + * URL) or not (false) * @since 3.1-A1 */ - $vars = array('url', 'params', 'is_amp', 'session_id', 'append_sid_override'); + $vars = array('url', 'params', 'is_amp', 'session_id', 'append_sid_overwrite'); extract($phpbb_dispatcher->trigger_event('core.append_sid', compact($vars))); - if ($append_sid_override) + if ($append_sid_overwrite) { - return $append_sid_override; + return $append_sid_overwrite; } // The following hook remains for backwards compatibility, though use of - // the event above is preferred. + // the event above is preferred. // Developers using the hook function need to globalise the $_SID and $_EXTRA_URL on their own and also handle it appropriately. // They could mimic most of what is within this function if (!empty($phpbb_hook) && $phpbb_hook->call_hook(__FUNCTION__, $url, $params, $is_amp, $session_id)) |