Function __global->cns_create_selection_list_usergroups

Definitions

sources/cns_groups.php

  • Get a nice list for selection from the usergroups. Suitable for admin use only (does not check hidden status).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$it ?AUTO_LINK No No Null N/A N/A Usergroup selected by default (null: no specific default)
$allow_guest_group boolean No No True N/A N/A Allow the guest usergroup to be in the list

Returns

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

Preview

Code (PHP)

/**
 * Get a nice list for selection from the usergroups. Suitable for admin use only (does not check hidden status).
 *
 * @param  ?AUTO_LINK $it Usergroup selected by default (null: no specific default)
 * @param  boolean $allow_guest_group Allow the guest usergroup to be in the list
 * @return Tempcode The list
 */
function cns_create_selection_list_usergroups(?int $it = null, bool $allow_guest_group = true) : object