Member Field Model

class ExpressionEngine\Model\member\memberField

Properties
Relationships
Methods
Events
Examples:

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`

Parameter	Type	Description
Returns	`array`	Returns the member field’s settings.

`getValues`

Parameter	Type	Description
Returns	`array`	Returns an array of field values for the member.

`getStructure`

Parameter	Type	Description
Returns	`object`	A link back to the Structure object that defines this Content’s structure.

`getContentType`

Parameter	Type	Description
Returns	`string`	Returns the content type `member`.

`getDataTable`

Parameter	Type	Description
Returns	`string`	Returns the name of the table, `member_data`.

`getColumnPrefix`

Parameter	Type	Description
Returns	`string`	Returns the prefix for member fields, `m_`.

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;