Function __global->cns_edit_group
Definitions
sources/cns_groups_action2.php
- Edit a usergroup.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $group_id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the usergroup to edit |
| $name | ?SHORT_TEXT | No | No | required parameter | N/A | N/A | The name of the usergroup. (null: do not change) |
| $is_default | ?BINARY | No | No | required parameter | N/A | N/A | Whether members are automatically put into the when they join. (null: do not change) |
| $is_super_admin | ?BINARY | No | No | required parameter | N/A | N/A | Whether members of this usergroup are all super-administrators. (null: do not change) |
| $is_super_moderator | ?BINARY | No | No | required parameter | N/A | N/A | Whether members of this usergroup are all super-moderators. (null: do not change) |
| $title | ?SHORT_TEXT | No | No | required parameter | N/A | N/A | The title for primary members of this usergroup that don't have their own title. (null: do not change) |
| $rank_image | ?URLPATH | No | No | required parameter | N/A | N/A | The rank image for this. (null: do not change) |
| $promotion_target | ?GROUP | No | No | required parameter | N/A | N/A | The that members of this usergroup get promoted to at point threshold (null: no promotion prospects) |
| $promotion_threshold | ?integer | No | No | required parameter | N/A | N/A | The point threshold for promotion (null: no promotion prospects) |
| $promotion_approval | ?BINARY | No | No | required parameter | N/A | N/A | Whether usergroup promotion should require manual approval (null: do not change) |
| $group_leader | ?MEMBER | No | No | required parameter | N/A | N/A | The leader of this usergroup (null: none) |
| $flood_control_submit_secs | ?integer | No | No | required parameter | N/A | N/A | The number of seconds that members of this usergroup must endure between submits (group 'best of' applies). (null: do not change) |
| $flood_control_access_secs | ?integer | No | No | required parameter | N/A | N/A | The number of seconds that members of this usergroup must endure between accesses (group 'best of' applies). (null: do not change) |
| $max_daily_upload_mb | ?integer | No | No | required parameter | N/A | N/A | The number of megabytes that members of this usergroup may attach per day (group 'best of' applies). (null: do not change) |
| $max_attachments_per_post | ?integer | No | No | required parameter | N/A | N/A | The number of attachments that members of this usergroup may attach to something (group 'best of' applies). (null: do not change) |
| $max_avatar_width | ?integer | No | No | required parameter | N/A | N/A | The maximum avatar width that members of this usergroup may have (group 'best of' applies). (null: do not change) |
| $max_avatar_height | ?integer | No | No | required parameter | N/A | N/A | The maximum avatar height that members of this usergroup may have (group 'best of' applies). (null: do not change) |
| $max_post_length_comcode | ?integer | No | No | required parameter | N/A | N/A | The maximum post length that members of this usergroup may make (group 'best of' applies). (null: do not change) |
| $max_sig_length_comcode | ?integer | No | No | required parameter | N/A | N/A | The maximum signature length that members of this usergroup may make (group 'best of' applies). (null: do not change) |
| $gift_points_base | ?integer | No | No | required parameter | N/A | N/A | The number of gift points that members of this usergroup start with (group 'best of' applies). (null: do not change) |
| $gift_points_per_day | ?integer | No | No | required parameter | N/A | N/A | The number of gift points that members of this usergroup get per day (group 'best of' applies). (null: do not change) |
| $enquire_on_new_ips | ?BINARY | No | No | required parameter | N/A | N/A | Whether e-mail confirmation is needed for new IP addresses seen for any member of this usergroup (group 'best of' applies). (null: do not change) |
| $is_presented_at_install | ?BINARY | No | No | required parameter | N/A | N/A | Whether the is presented for joining at joining (implies anyone may be in the, but only choosable at joining) (null: do not change) |
| $hidden | ?BINARY | No | No | required parameter | N/A | N/A | Whether the name and membership of the is hidden (null: do not change) |
| $order | ?integer | No | No | required parameter | N/A | N/A | The display order this will be given, relative to other usergroups. Lower numbered usergroups display before higher numbered usergroups. (null: do not change) |
Preview
Code (PHP)
/**
* Edit a usergroup.
*
* @param AUTO_LINK $group_id The ID of the usergroup to edit
* @param ?SHORT_TEXT $name The name of the usergroup. (null: do not change)
* @param ?BINARY $is_default Whether members are automatically put into the when they join. (null: do not change)
* @param ?BINARY $is_super_admin Whether members of this usergroup are all super-administrators. (null: do not change)
* @param ?BINARY $is_super_moderator Whether members of this usergroup are all super-moderators. (null: do not change)
* @param ?SHORT_TEXT $title The title for primary members of this usergroup that don't have their own title. (null: do not change)
* @param ?URLPATH $rank_image The rank image for this. (null: do not change)
* @param ?GROUP $promotion_target The that members of this usergroup get promoted to at point threshold (null: no promotion prospects)
* @param ?integer $promotion_threshold The point threshold for promotion (null: no promotion prospects)
* @param ?BINARY $promotion_approval Whether usergroup promotion should require manual approval (null: do not change)
* @param ?MEMBER $group_leader The leader of this usergroup (null: none)
* @param ?integer $flood_control_submit_secs The number of seconds that members of this usergroup must endure between submits (group 'best of' applies). (null: do not change)
* @param ?integer $flood_control_access_secs The number of seconds that members of this usergroup must endure between accesses (group 'best of' applies). (null: do not change)
* @param ?integer $max_daily_upload_mb The number of megabytes that members of this usergroup may attach per day (group 'best of' applies). (null: do not change)
* @param ?integer $max_attachments_per_post The number of attachments that members of this usergroup may attach to something (group 'best of' applies). (null: do not change)
* @param ?integer $max_avatar_width The maximum avatar width that members of this usergroup may have (group 'best of' applies). (null: do not change)
* @param ?integer $max_avatar_height The maximum avatar height that members of this usergroup may have (group 'best of' applies). (null: do not change)
* @param ?integer $max_post_length_comcode The maximum post length that members of this usergroup may make (group 'best of' applies). (null: do not change)
* @param ?integer $max_sig_length_comcode The maximum signature length that members of this usergroup may make (group 'best of' applies). (null: do not change)
* @param ?integer $gift_points_base The number of gift points that members of this usergroup start with (group 'best of' applies). (null: do not change)
* @param ?integer $gift_points_per_day The number of gift points that members of this usergroup get per day (group 'best of' applies). (null: do not change)
* @param ?BINARY $enquire_on_new_ips Whether e-mail confirmation is needed for new IP addresses seen for any member of this usergroup (group 'best of' applies). (null: do not change)
* @param ?BINARY $is_presented_at_install Whether the is presented for joining at joining (implies anyone may be in the, but only choosable at joining) (null: do not change)
* @param ?BINARY $hidden Whether the name and membership of the is hidden (null: do not change)
* @param ?integer $order The display order this will be given, relative to other usergroups. Lower numbered usergroups display before higher numbered usergroups. (null: do not change)
*/
function cns_edit_group(int $group_id, ?string $name, ?int $is_default, ?int $is_super_admin, ?int $is_super_moderator, ?string $title, ?string $rank_image, ?int $promotion_target, ?int $promotion_threshold, ?int $promotion_approval, ?int $group_leader, ?int $flood_control_submit_secs, ?int $flood_control_access_secs, ?int $max_daily_upload_mb, ?int $max_attachments_per_post, ?int $max_avatar_width, ?int $max_avatar_height, ?int $max_post_length_comcode, ?int $max_sig_length_comcode, ?int $gift_points_base, ?int $gift_points_per_day, ?int $enquire_on_new_ips, ?int $is_presented_at_install, ?int $hidden, ?int $order)
* Edit a usergroup.
*
* @param AUTO_LINK $group_id The ID of the usergroup to edit
* @param ?SHORT_TEXT $name The name of the usergroup. (null: do not change)
* @param ?BINARY $is_default Whether members are automatically put into the when they join. (null: do not change)
* @param ?BINARY $is_super_admin Whether members of this usergroup are all super-administrators. (null: do not change)
* @param ?BINARY $is_super_moderator Whether members of this usergroup are all super-moderators. (null: do not change)
* @param ?SHORT_TEXT $title The title for primary members of this usergroup that don't have their own title. (null: do not change)
* @param ?URLPATH $rank_image The rank image for this. (null: do not change)
* @param ?GROUP $promotion_target The that members of this usergroup get promoted to at point threshold (null: no promotion prospects)
* @param ?integer $promotion_threshold The point threshold for promotion (null: no promotion prospects)
* @param ?BINARY $promotion_approval Whether usergroup promotion should require manual approval (null: do not change)
* @param ?MEMBER $group_leader The leader of this usergroup (null: none)
* @param ?integer $flood_control_submit_secs The number of seconds that members of this usergroup must endure between submits (group 'best of' applies). (null: do not change)
* @param ?integer $flood_control_access_secs The number of seconds that members of this usergroup must endure between accesses (group 'best of' applies). (null: do not change)
* @param ?integer $max_daily_upload_mb The number of megabytes that members of this usergroup may attach per day (group 'best of' applies). (null: do not change)
* @param ?integer $max_attachments_per_post The number of attachments that members of this usergroup may attach to something (group 'best of' applies). (null: do not change)
* @param ?integer $max_avatar_width The maximum avatar width that members of this usergroup may have (group 'best of' applies). (null: do not change)
* @param ?integer $max_avatar_height The maximum avatar height that members of this usergroup may have (group 'best of' applies). (null: do not change)
* @param ?integer $max_post_length_comcode The maximum post length that members of this usergroup may make (group 'best of' applies). (null: do not change)
* @param ?integer $max_sig_length_comcode The maximum signature length that members of this usergroup may make (group 'best of' applies). (null: do not change)
* @param ?integer $gift_points_base The number of gift points that members of this usergroup start with (group 'best of' applies). (null: do not change)
* @param ?integer $gift_points_per_day The number of gift points that members of this usergroup get per day (group 'best of' applies). (null: do not change)
* @param ?BINARY $enquire_on_new_ips Whether e-mail confirmation is needed for new IP addresses seen for any member of this usergroup (group 'best of' applies). (null: do not change)
* @param ?BINARY $is_presented_at_install Whether the is presented for joining at joining (implies anyone may be in the, but only choosable at joining) (null: do not change)
* @param ?BINARY $hidden Whether the name and membership of the is hidden (null: do not change)
* @param ?integer $order The display order this will be given, relative to other usergroups. Lower numbered usergroups display before higher numbered usergroups. (null: do not change)
*/
function cns_edit_group(int $group_id, ?string $name, ?int $is_default, ?int $is_super_admin, ?int $is_super_moderator, ?string $title, ?string $rank_image, ?int $promotion_target, ?int $promotion_threshold, ?int $promotion_approval, ?int $group_leader, ?int $flood_control_submit_secs, ?int $flood_control_access_secs, ?int $max_daily_upload_mb, ?int $max_attachments_per_post, ?int $max_avatar_width, ?int $max_avatar_height, ?int $max_post_length_comcode, ?int $max_sig_length_comcode, ?int $gift_points_base, ?int $gift_points_per_day, ?int $enquire_on_new_ips, ?int $is_presented_at_install, ?int $hidden, ?int $order)
