[feature/php-events] Add docs and fix naming of core.viewonline_modify_sql

PHPBB3-9550
This commit is contained in:
Joas Schilling 2012-07-28 15:02:05 +02:00
parent 16736d4e4c
commit 97f50c9771

View file

@ -133,8 +133,16 @@ $sql_ary = array(
'ORDER_BY' => $order_by,
);
/**
* Modify the SQL query for getting the user data to display viewonline list
*
* @event core.viewonline_modify_sql
* @var array sql_ary The SQL array
* @var bool show_guests Do we display guests in the list
* @since 3.1-A1
*/
$vars = array('sql_ary', 'show_guests');
extract($phpbb_dispatcher->trigger_event('core.viewonline_get_userdata', compact($vars)));
extract($phpbb_dispatcher->trigger_event('core.viewonline_modify_sql', compact($vars)));
$result = $db->sql_query($db->sql_build_query('SELECT', $sql_ary));