Function Forum_driver_base->get_members_groups

Definitions

sources/forum_stub.php

  • Get a list of usergroups a member is in.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id MEMBER No No required parameter N/A N/A The member
$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 list of usergroups
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a list of usergroups a member is in.
 *
 * @param  MEMBER $id The member
 * @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 list of usergroups
 */
public function get_members_groups(int $id, bool $skip_secret = false, bool $handle_probation = true, bool $skip_cache = false) : array