Function __global->show_im_contacts

Definitions

sources/chat_lobby.php

  • Show IM contacts, with online/offline status and clickability to initiate IM sessions.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$member_id ?MEMBER No No Null N/A N/A The member ID (null: current user)
$simpler boolean No No False N/A N/A Whether to show a simpler, more compact, UI
$max ?integer No No Null N/A N/A Maximum to show (null: default)

Returns

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

Preview

Code (PHP)

/**
 * Show IM contacts, with online/offline status and clickability to initiate IM sessions.
 *
 * @param  ?MEMBER $member_id The member ID (null: current user)
 * @param  boolean $simpler Whether to show a simpler, more compact, UI
 * @param  ?integer $max Maximum to show (null: default)
 * @return Tempcode The contact UI
 */
function show_im_contacts(?int $member_id = null, bool $simpler = false, ?int $max = null) : object