phpBB API Documentation
Class

acp_users

class acp_users

Properties

$u_action
$p_master

Methods

acp_users($p_master)

main($id, $mode)

int|bool optionset(array $user_row, int $key, bool $value, int $data = false)

Set option bit field for user options in a user row array.

bool optionget(array $user_row, int $key, int $data = false)

Get option bit field from user options in a user row array.

Details

at line 27
public acp_users($p_master)

Parameters

$p_master

at line 32
public main($id, $mode)

Parameters

$id
$mode

at line 2627
public int|bool optionset(array $user_row, int $key, bool $value, int $data = false)

Set option bit field for user options in a user row array.

Optionset replacement for this module based on $user->optionset.

Parameters

array $user_row Row from the users table.
int $key Option key, as defined in $user->keyoptions property.
bool $value True to set the option, false to clear the option.
int $data Current bit field value, or false to use $userrow['useroptions']

Return Value

int|bool If $data is false, the bit field is modified and written back to $userrow['useroptions'], and return value is true if the bit field changed and false otherwise. If $data is not false, the new bitfield value is returned.

at line 2663
public bool optionget(array $user_row, int $key, int $data = false)

Get option bit field from user options in a user row array.

Optionget replacement for this module based on $user->optionget.

Parameters

array $user_row Row from the users table.
int $key option key, as defined in $user->keyoptions property.
int $data bit field value to use, or false to use $userrow['useroptions']

Return Value

bool true if the option is set in the bit field, false otherwise