groupsAllowedTo

Description

Retrieves a list of membergroups that are allowed to do the given permission.

Syntax

array groupsAllowedTo (string $permission[, int $board_id])


Parameter $permission

Expected type: String
Description: The permission


Parameter $board_id

Expected type: Integer
Description: If specified, finds any members who have the specified permission on the given board; otherwise assumes it's a global permission.


Return value

Expected type: Array
Description:

Array Elements
Key Optional Expected type Description
allowed no Array An array containing the IDs of groups that have the specified permission
denied no Array An array containing the IDs of groups that are specifically denied the specified permission


Notes

  • If board_id is not null, a board permission is assumed.
  • Takes different permission settings into account.
  • Returns an array containing an array for the allowed membergroup IDs and an array for the denied membergroup IDs.
View all versions of this function
Advertisement: