Member Field Model

class ExpressionEngine\Model\member\memberField

Properties

Required

• m_field_name
• m_field_label
• m_field_type

Optional

• m_field_id Key
• m_field_description
• m_field_list_items
• m_field_ta_rows
• m_field_maxl
• m_field_width
• m_field_search
• m_field_required
• m_field_public
• m_field_reg
• m_field_cp_reg
• m_field_fmt
• m_field_show_fmt
• m_field_exclude_from_anon boolString
• m_field_order
• m_field_text_direction
• m_field_settings json
• m_legacy_field_data boolString

Relationships

No Relationships.

Methods

getSettingsValues

getValues

getStructure

getContentType

getDataTable

getColumnPrefix

Events

Saving with this model will trigger the following events:

• beforeInsert

Examples

Get All Custom Member Fields

$all_member_fields = ee('Model')
        ->get('MemberField')
        ->fields('m_field_label','m_field_id')
        ->all()
        ->getDictionary('m_field_id', 'm_field_label');

// Example return: [4 => 'My Field Name']

Create a member field

$new_field = ee('Model')->make('MemberField');
$new_field->m_field_type        = 'text';
$new_field->m_field_label       = 'My Member Field';
$new_field->m_field_name        = 'my_member_field';
$new_field->m_field_description = 'A custom member field example';
$new_field->m_field_settings    = array();
$new_field->m_field_show_fmt    = 'n';

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

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

// The field ID is now available.
$field_id = $new_field->m_field_id;

Accessing a custom member field from a member model instance by member field ID

Please note, this is the way to access custom member fields. To access built-in member fields, see below.

$member_id = 3;  // Example member ID
$field_column_name = 'm_field_id_1';  // Based on the field ID being 1

$member = ee('Model')->get('Member', $member_id)->first();
echo $member->$field_column_name;

Accessing a custom member field from a member model instance by member field short name

Please note, this is the way to access custom member fields. To access built-in member fields, see below.

$member_id = 3;  // Example member ID

// Based on the member field short name being `first_name`
$field = ee('Model')->get('MemberField')->filter('m_field_name', 'first_name')->first();
$field_column_name = 'm_field_id_'.$field->m_field_id;

$member = ee('Model')->get('Member', $member_id)->first();
echo $member->$field_column_name;

Accessing built-in member fields from a member model instance

$member_id = 3;  // Example member ID

$member = ee('Model')->get('Member', $member_id)->first();
echo $member->screen_name;

---

ExpressionEngine 7 Docs
©2002–2024 Packet Tide,LLC. Edit this page