Member Model

class ExpressionEngine\Model\Member\Member

Properties
Relationships
Methods
Events
Examples:

Relationships

`PrimaryRole`

Primary Role that the member belongs to.

`Roles`

Additional Roles the member is assigned to. May or may not include Primary Role.

`RoleGroups`

Role Groups assigned to member.

Note: To get full list of Roles assigned to member, use getAllRoles() function.

`LastAuthoredSpecialtyTemplates`

Specialty Templates last edited by member.

`VersionedChannelEntries`

Channel Entry Versions created by member.

`TemplateRevisions`

Template RevisionTracker records that the member is author of.

`SiteStatsIfLastMember`

Stats for the site where member is last registered user.

`CommentSubscriptions`

Member’s Subscriptions for new comment notifications

`AuthoredConsentRequests`

Consent Request Versions authored by member.

`ConsentAuditLogs`

Records in Consent Audit Log for member.

`SentMessageReceipts`

Message Copy records for private messages sent by member.

`SentAttachments`

Attachments to private messages sent by member.

`ReceivedMessageReceipts`

Message Copy records for private messages received by member.

`ListedMembers`

Members Listed (as buddy or blocked) by user.

Methods

`getMemberName()`

Gets the member’s name

Parameter	Type	Description
Returns	`String`	The member’s name

`getHTMLButtonsForSite($site_id)`

Gets the HTML buttons for a given site id for this member. Falls back to the site’s defined HTML buttons

Parameter	Type	Description
$site_id	`Int`	The site ID
Returns	`Collection`	A collection of `HTMLButton` entities

`updateAuthorStats()`

Updates the author’s total_entries and total_comments stats based on the ChannelEntry and Comment counts.

Parameter	Type	Description
Returns	`Void`

Returns the URL to use for the homepage for this member, otherwise we’ll use the default of ‘homepage’. We prioritize on the Member’s preferences then the groups preferences, falling back to the default.

Parameter	Type	Description
$site_id	`Int`	The site ID, defaults to current site
Returns	`CP\URL`	The URL

`getAvatarUrl()`

Get the full URL to the Avatar

Parameter	Type	Description
Returns	`String`	Avatar URL

`getSignatureImageUrl()`

Get the full URL to the Signature Image

Parameter	Type	Description
Returns	`String`	Signature Image URL

`anonymize()`

Anonymize a member record in order to comply with a GDPR Right to Erasure request

Parameter	Type	Description
Returns	`Void`

`isAnonymized()`

Checks whether this member already been anonymized

Parameter	Type	Description
Returns	`Bool`	`TRUE` if the user has been anonymized

`getAllRoles()`

Get all roles assigned to member, including Primary Role, extra roles and roles assigned via Role Groups

Parameter	Type	Description
Returns	`Collection`	all roles assigned to member

`getAssignedModules()`

Get all modules that the member is allowed to access

Parameter	Type	Description
Returns	`Collection`	Collection of `Module` entities

`getAssignedChannels()`

Get all channels that the member is allowed to use

Parameter	Type	Description
Returns	`Collection`	Collection of `Channel` entities

`getAssignedUploadDestinations()`

Get all upload destination that the member is allowed to use

Parameter	Type	Description
Returns	`Collection`	Collection of `UploadDestination` entities

`getAssignedStatuses()`

Get all entry statuses that the member is allowed to use

Parameter	Type	Description
Returns	`Collection`	Collection of `Status` entities

`getAssignedTemplateGroups()`

Get all template groups that the member is allowed to manipulate

Parameter	Type	Description
Returns	`Collection`	Collection of `TemplateGroup` entities

`getAssignedTemplates()`

Get all templates that the member is allowed to access

Parameter	Type	Description
Returns	`Collection`	Collection of `Template` entities

`getPermissions()`

Get permissions assigned to member

Parameter	Type	Description
Returns	`Array`	`[permission => permission_id]`

`has($permission)`

Checks whether member has certain permission

Parameter	Type	Description
$permission	`String`	Full permission name
Returns	`Bool`	`TRUE` if permission has been granted

`isSuperAdmin()`

Checks whether member is SuperAdmin

Parameter	Type	Description
Returns	`Bool`	`TRUE` if if member is SuperAdmin

`isBanned()`

Checks whether member has been banned

Parameter	Type	Description
Returns	`Bool`	`TRUE` if if member is banned

`isPending()`

Checks whether member is pending

Parameter	Type	Description
Returns	`Bool`	`TRUE` if if member is pending

$username = 'bob';
$member_object = ee('Model')->get('Member')->filter('username', $username)->first();

Get A Member’s Roles

$username = 'bob';
$member_roles_object = ee('Model')->get('Member')->filter('username', $username)->first()->getAllRoles();

Change Member’s Primary Role

$new_role_id = 8;
$member_object->role_id = $new_role_id;

// Validate and Save.
$result = $member_object->validate();

if ($result->isValid())
{
  $member_object->save();
}

Add additional Roles to Member

// Get the member object.
$member_object = ee('Model')->get('Member')->filter('username', $username)->first();

// Get Member's existing role ID.
$current_role_ids = $member_object->Roles->pluck('role_id');

// Your list of new roles to add.
$roles_to_add = array(5,6);

// Merge the two arrays.
$all_roles = array_merge($current_role_ids, $roles_to_add);

// Add the roles to the member.
$member_object->Roles = ee('Model')->get('Role', $all_roles)->all();

// Validate and Save.
$result = $member_object->validate();

if ($result->isValid())
{
  $member_object->save();
}

Set Member Custom Field

$field_id = '26';
$member_object->{'m_field_id_'.$field_id} = 'New Field Value';

// Validate and Save.
$result = $member_object->validate();

if ($result->isValid())
{
  $member_object->save();
}

Create a New Member

$password_array = ee()->auth->hash_password($unencrypted_password);

$member_data = array(

    'role_id'    => 6,
    'username'   => 'bobsmith123', // unique.
    'email'      => 'example@gmail.com`,  // unique.
    'password'   => $password_array['password'],
    'ip_address' => ee()->input->ip_address(),
    'unique_id'  => ee('Encrypt')->generateKey(),
    'crypt_key'  => ee('Encrypt')->generateKey(),
    'join_date'  => ee()->localize->now,
    'language'   => ee()->config->item('deft_lang'),

);

$member = ee('Model')->make('Member');
$member->set($member_data);

// Validate and Save.
$result = $member->validate();

if ($result->isValid())
{
  $member->save();
}

Getting Started

The Fundamentals

Advanced Usage

Best Practices

Community