Function Forum_driver_cns->_get_members_groups

Definitions

sources/forum/cns.php

  • Get the forum usergroup relating to the specified member ID.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$member_id MEMBER No No required parameter N/A N/A The member ID
$skip_secret boolean No No False N/A N/A Whether to skip looking at secret usergroups, unless we have access
$handle_probation boolean No No True N/A N/A Whether to take probation into account
$skip_cache boolean No No False N/A N/A Whether to skip the user groups cache

Returns

  • The array of forum usergroups
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the forum usergroup relating to the specified member ID.
 *
 * @param  MEMBER $member_id The member ID
 * @param  boolean $skip_secret Whether to skip looking at secret usergroups, unless we have access
 * @param  boolean $handle_probation Whether to take probation into account
 * @param  boolean $skip_cache Whether to skip the user groups cache
 * @return array The array of forum usergroups
 */
protected function _get_members_groups(int $member_id, bool $skip_secret = false, bool $handle_probation = true, bool $skip_cache = false) : array