Function __global->get_chatters_in_room_tpl

Definitions

sources/chat.php

  • Get some template code showing the number of chatters in a room.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$users array No No required parameter N/A N/A A mapping (user=>username) of the chatters in the room

Returns

  • The Tempcode
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get some template code showing the number of chatters in a room.
 *
 * @param  array $users A mapping (user=>username) of the chatters in the room
 * @return Tempcode The Tempcode
 */
function get_chatters_in_room_tpl(array $users) : object