Function __global->get_members_viewing_wrap

Definitions

sources/users2.php

  • Get template-ready details of members viewing the specified software location.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$page ?ID_TEXT No No Null N/A N/A The page they need to be viewing (null: don't care)
$type ?ID_TEXT No No Null N/A N/A The page-type they need to be viewing (null: don't care)
$id ?SHORT_TEXT No No Null N/A N/A The type-id they need to be viewing (null: don't care)
$forum_layer boolean No No False N/A N/A Whether this has to be done over the forum driver (multi site network)

Returns

  • A map of member-IDs to rows about them (null: Too many)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get template-ready details of members viewing the specified software location.
 *
 * @param  ?ID_TEXT $page The page they need to be viewing (null: don't care)
 * @param  ?ID_TEXT $type The page-type they need to be viewing (null: don't care)
 * @param  ?SHORT_TEXT $id The type-id they need to be viewing (null: don't care)
 * @param  boolean $forum_layer Whether this has to be done over the forum driver (multi site network)
 * @return ?array A map of member-IDs to rows about them (null: Too many)
 */
function get_members_viewing_wrap(?string $page = null, ?string $type = null, ?string $id = null, bool $forum_layer = false) : ?array