Function __global->cns_edit_member
Definitions
sources/cns_members_action2.php
- Edit a member.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $allow_emails | ?BINARY | No | No | Null | N/A | N/A | Whether the member allows e-mails via the site (null: don't change) |
| $allow_emails_from_staff | ?BINARY | No | No | Null | N/A | N/A | Whether the member allows e-mails from staff via the site (null: don't change) |
| $highlighted_name | ?BINARY | No | No | Null | N/A | N/A | Whether the member username will be highlighted (null: don't change) |
| $pt_allow | ?SHORT_TEXT | No | No | * | N/A | N/A | Usergroups that may PT the member (null: don't change) |
| $pt_rules_text | ?LONG_TEXT | No | No | Blank (empty string) | N/A | N/A | Rules that other members must agree to before they may start a PT with the member (null: don't change) |
| $validated | ?BINARY | No | No | Null | N/A | N/A | Whether the account has been validated (null: do not change this) (null: don't change) |
| $probation_expiration_time | ?TIME | No | No | Null | N/A | N/A | When the member is on probation until (null: don't change) |
| $is_perm_banned | ?ID_TEXT | No | No | Null | N/A | N/A | Banned status (null: don't change) |
| $check_correctness | boolean | No | No | True | N/A | N/A | Whether to check details for correctness and do most of the change-triggered e-mails |
| $password_compat_scheme | ?ID_TEXT | No | No | Null | N/A | N/A | Password compatibility scheme (null: don't change) |
| $salt | ?SHORT_TEXT | No | No | Null | N/A | N/A | Password salt (null: don't change) (blank: generate a new one depending on our password compat scheme) |
| $join_time | ?TIME | No | No | Null | N/A | N/A | When the member joined (null: don't change) |
| $sensitive_change_alert | ?boolean | No | No | Null | N/A | N/A | Whether to send an alert to the member that their login information has changed, if applicable (null: use the value of $check_correctness) |
Preview
Code (PHP)
/**
* Edit a member.
*
* @param ?BINARY $allow_emails Whether the member allows e-mails via the site (null: don't change)
* @param ?BINARY $allow_emails_from_staff Whether the member allows e-mails from staff via the site (null: don't change)
* @param ?BINARY $highlighted_name Whether the member username will be highlighted (null: don't change)
* @param ?SHORT_TEXT $pt_allow Usergroups that may PT the member (null: don't change)
* @param ?LONG_TEXT $pt_rules_text Rules that other members must agree to before they may start a PT with the member (null: don't change)
* @param ?BINARY $validated Whether the account has been validated (null: do not change this) (null: don't change)
* @param ?TIME $probation_expiration_time When the member is on probation until (null: don't change)
* @param ?ID_TEXT $is_perm_banned Banned status (null: don't change)
* @param boolean $check_correctness Whether to check details for correctness and do most of the change-triggered e-mails
* @param ?ID_TEXT $password_compat_scheme Password compatibility scheme (null: don't change)
* @param ?SHORT_TEXT $salt Password salt (null: don't change) (blank: generate a new one depending on our password compat scheme)
* @param ?TIME $join_time When the member joined (null: don't change)
* @param ?boolean $sensitive_change_alert Whether to send an alert to the member that their login information has changed, if applicable (null: use the value of $check_correctness)
*/
function cns_edit_member(?int $allow_emails = null, ?int $allow_emails_from_staff = null, ?int $highlighted_name = null, ?string $pt_allow = '*', ?string $pt_rules_text = '', ?int $validated = null, ?int $probation_expiration_time = null, ?string $is_perm_banned = null, bool $check_correctness = true, ?string $password_compat_scheme = null, ?string $salt = null, ?int $join_time = null, ?bool $sensitive_change_alert = null)
* Edit a member.
*
* @param ?BINARY $allow_emails Whether the member allows e-mails via the site (null: don't change)
* @param ?BINARY $allow_emails_from_staff Whether the member allows e-mails from staff via the site (null: don't change)
* @param ?BINARY $highlighted_name Whether the member username will be highlighted (null: don't change)
* @param ?SHORT_TEXT $pt_allow Usergroups that may PT the member (null: don't change)
* @param ?LONG_TEXT $pt_rules_text Rules that other members must agree to before they may start a PT with the member (null: don't change)
* @param ?BINARY $validated Whether the account has been validated (null: do not change this) (null: don't change)
* @param ?TIME $probation_expiration_time When the member is on probation until (null: don't change)
* @param ?ID_TEXT $is_perm_banned Banned status (null: don't change)
* @param boolean $check_correctness Whether to check details for correctness and do most of the change-triggered e-mails
* @param ?ID_TEXT $password_compat_scheme Password compatibility scheme (null: don't change)
* @param ?SHORT_TEXT $salt Password salt (null: don't change) (blank: generate a new one depending on our password compat scheme)
* @param ?TIME $join_time When the member joined (null: don't change)
* @param ?boolean $sensitive_change_alert Whether to send an alert to the member that their login information has changed, if applicable (null: use the value of $check_correctness)
*/
function cns_edit_member(?int $allow_emails = null, ?int $allow_emails_from_staff = null, ?int $highlighted_name = null, ?string $pt_allow = '*', ?string $pt_rules_text = '', ?int $validated = null, ?int $probation_expiration_time = null, ?string $is_perm_banned = null, bool $check_correctness = true, ?string $password_compat_scheme = null, ?string $salt = null, ?int $join_time = null, ?bool $sensitive_change_alert = null)