Skip to documentation content

Profile

Profile

The profile object and its methods for profile data and settings.

{{ profile }}

Properties
Properties of {{ profile }} objects
Name Type Description
object_type string Will always be profile
is_valid boolean True if this references a published profile
guid string The unique identifier for this profile
value string Contains the same value as guid
id string The identifier for the profile. May or may not be the same as email, depending on the site settings
email string Email address for this profile
force_password_reset boolean If true, the user must reset their password at next login
is_active boolean If true, the profile is active and can be used. If false, the profile must be activated before it may be used
date_activated {{ time }} The date that this profile was activated
date_activation_code_expires {{ time }} The date when the activation code will expire and no longer be valid
date_first_activated {{ time }} The date of the first successful activation for this profile
is_locked boolean If true, this profile is temporarily locked and may not be used to sign in until it is unlocked
date_locked_through {{ time }} If this profile is locked, this will be set to the date that the profile will be automatically unlocked
date_last_logged_in {{ time }} The date that this profile was last used to sign in to the website
is_blocked boolean If true, this profile has been permanently blocked and may not be used to sign in
date_blocked {{ time }} If this profile is blocked, this will be set to the date when the profile was blocked
attributes {{ dictionary }} The custom attributes for this profile. Attributes may either be manually set in the Marketpath CMS UI or programmatically set from template markup
logged_in boolean True if this profile is presently logged in on the current request
can_login boolean True if the profile exists, is active, and is not blocked or locked
settings object An object containing all of the custom profile settings for this profile
field_id string The identifier for this field
label string The label for this field
output string The default output that the profile produces when output directly to the template. Currently simply outputs the email, but the default output may change at any time. Template developers should avoid using this and should handle the output of profiles themselves
Example List all custom properties on client, session, or userIterate over the client, session, or profile to list all custom properties. The same patterns works for each object type.

Enumerate Client properties

Liquid
<h4>Client Properties:</h4>
<ul>
{%- for property in client -%}
	<li><strong>{{property}}</strong> = {{ client[property] }}</li>
{%- endfor -%}
</ul>

This example outputs a list of all of the client properties for the current client. Using {% for property in client.properties %} would produce the same result.

Enumerate Session properties

Liquid
<h4>Session Properties:</h4>
<ul>
{%- for property in session -%}
	<li><strong>{{property}}</strong> = {{ session[property] }}</li>
{%- endfor -%}
</ul>

This example outputs a list of all of the session properties for the current session. Using {% for property in session.properties %} would produce the same result.

Enumerate Profile attributes (mostly safe)

Liquid
<h4>Profile Attributes:</h4>
<ul>
{%- for property in profile -%}
	<li><strong>{{property}}</strong> = {{ profile[property] }}</li>
{%- endfor -%}
</ul>

This example will work as long as there are no profile settings with the same names as the profile attributes. In that case, the profile setting would be output instead of the profile attribute. To avoid this, you can use profile.attributes[property] instead.

Enumerate Profile attributes (safe)

Liquid
<h4>Profile Attributes:</h4>
<ul>
{%- for property in profile -%}
	<li><strong>{{property}}</strong> = {{ profile.attributes[property] }}</li>
{%- endfor -%}
</ul>

Outputs a list of all of the profile settings for the current profile, and does not risk outputting profile settings instead of profile attributes.

Example Set the current user's profileAssociate the current user with a profile using set_profile so profile-specific content and settings apply.
Liquid
{%- if submission.is_valid -%}
	{%- var bestScoreName = form.name.value | classname | prepend:'bestscore-' -%}
	{%- var bestScore = submission.score | to_int -%}
	{%- var previousBestScore = profile.attributes[bestScoreName] | to_int -%}
	{%- if previousBestScore > bestScore -%}
		{%- set bestScore = previousBestScore -%}
	{%- endif -%}
	{%- set_profile last_score:submission.score &bestScoreName:bestScore -%}
{%- endif -%}

{{ profiles }}

Contains multiple profiles.

Properties
Properties of {{ profiles }} objects
Name Type Description
object_type string Will always be profiles
is_valid boolean True if this contains at least one published profile
output string The default output that the profiles will produce when it is output directly to the template - using the "output_in_list" property of each profile in the items list
prepended list List containing any prepended profiles.
fetched list List containing all of the profiles that were fetched from the database (as opposed to prepended or appended).
appended list List containing any appended profiles.
appended_unique list List containing any appended profiles excluding any profiles that are in either the list of prepended or fetched profiles.
items list List containing all of the combined profiles from the prepended, fetched, and appended lists. If unique is true, this list will not contain any duplicates. If max_size is set, this list will not contain more than the number of profiles specified.
size integer The total number of profiles in the items list, including prepended, fetched, and appended lists, and respecting the unique and max_size properties.
max_size integer If set, this is the maximum number of items that will be returned in the items list and the maximum number of items that will be included when this profiles object is enumerated as a list. When not set, this value will be 0.
unique boolean When true, the items list will not contain any duplicates. Only the first instance of each profile will be included.
limit integer The maximum number of items that were allowed to be in the list of fetched profiles. May be 0 in some cases (such as when when there are no fetched profiles.
start integer The 1-based index of the first item in the list of fetched profiles.
page integer The 1-based index of the paginated results returned in the list of fetched profiles, which is calculated from the start and limit parameters. Useful for paginated results.
total_count integer The 1-based index of the first item in the list of fetched profiles
total_pages integer If any items were fetched from the database, total_pages will contain the number of paginated result pages in the database for the provided arguments. This may also be calculated using the total_count and limit properties.

{% profile %}

{% profile output_to_template? [[var, set, or assign]? variable]? output_to_template? = value %}
Parameters
output_to_template optionalflag
If included the {% profile %} will be output directly to the template.
var, set, or assign optionalkeyword
Optional. Specify either "var", "set" or "assign" to change which scope this {% profile %} is stored on. "var" is the default behavior.
variable_name optionalvariable
Specify a variable name in order to save this profile to a variable. If not specified, it will be output to the template instead.
value requiredexpression
Should evaluate to an object of type profile, or the name or guid of one. May use liquid filters.

Fetches a single {{ profile }}.

{% profiles %}

{% profiles output_to_template? [[var, set, or assign]? variable]? output_to_template? = arguments %}
Parameters
output_to_template optionalflag
If included the {% profiles %} will be output directly to the template.
var, set, or assign optionalkeyword
Optional. Specify either "var", "set" or "assign" to change which scope this {% profiles %} is stored on. "var" is the default behavior.
variable optionalvariable
arguments requiredcollection
Key:value pairs. May use the variable arguments syntax.

Options

prepend optionallist
May be a single profile, a list of profiles, or the name or guid of one profile, to be included at the beginning of the profiles list.
append optionallist
May be a single profile, a list of profiles, or the name or guid of one profile, to be included at the end of the profiles list.
exclude optionallist
May be a single profile, a list of profiles, or the name or guid of one profile that should NOT be included in the fetched results. Has no effect on prepended or appended profiles.
exclude_prepended optionalboolean
True to specifically exclude all prepended profiles from the fetched results. If "unique:true" is specified this is the default behavior, although you may also specify "exclude_prepended:false" to allow any prepended items to be fetched along with other results anyway.
exclude_appended optionalboolean
True to specifically exclude all appended profiles from the fetched results. This is false by default - even if "unique:true" is specified - so that results are returned in the proper order.
unique optionalboolean
True to remove duplicates from each of the resulting lists (prepended, fetched, appended, and items), although there may be duplicates between the prepended, fetched, and appended lists. The "items" list will include objects in the order in which they appear - with prepended items first, then fetched items, then appended items.
max_size optionalinteger
The maximum number of items to be included in the "items" list. If there are any prepended or appended items, this will automatically lower the "limit" to only fetch as many profiles as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting profiles. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
filter optionalvalue
Only include profiles that match the given string filter
is_active optionalvalue
only include profiles that either are or are not active
is_blocked optionalvalue
Only include profiles that either are or are not blocked
query optionalvalue
Only include profiles whose custom settings match the given query. As with datastore item queries, only custom (configurable) profile settings are queryable this way, not built-in/reserved profile properties. Profile queries share the same advanced syntax as datastore item queries, which may be reviewed at https://help.marketpath.com/liquid/advanced-datastore-queries
attributes optionalvalue
Only include profiles whose custom attributes match the given query. As with datastore item queries, only custom (configurable) profile attributes are queryable this way, not built-in/reserved profile properties. Profile queries share the same advanced syntax as datastore item queries, which may be reviewed at https://help.marketpath.com/liquid/advanced-datastore-queries
date_logged_in_start optionalvalue
Only include profiles with date_last_logged_in greater than or equal to date_logged_in_start
date_logged_in_end optionalvalue
Only include profiles with date_last_logged_in less than or equal to date_logged_in_end
date_created_start optionalvalue
Only include profiles with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the profile was first published.
date_created_end optionalvalue
Only include profiles with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the profile was first published.
start optionalinteger
Set the 1-based index of the first profile to fetch.
page optionalinteger
Used to automatically calculate the first profile to fetch based on both the "limit" and the 1-based "page" value. Defaults to 1, but is ignored if "start" is set.
limit optionalinteger
The maximum number of profiles to fetch. Defaults to 10. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.
sort_by optionalstring
Specify which property to sort the results by. Has no effect on prepended or appended profiles. By default, results will be sorted by relevance if there is a filter string and date_created desc (newest first) if not. Options include:
  • relevance: only applies when there is a filter string. When sorting by relevance sort_direction is ignored.
  • date_created: the date each profile was first published. Unpublishing and republishing one resets date_created to the current date.
  • random: results will be returned in a random order, which prevents the page from being fast-cached. Setting cache_random:true overrides this behavior and allows the page to be fast-cached anyway.
  • name
  • title
  • url
  • browser_title
sort_direction optionalstring
asc or desc.
cache_random optionalboolean
True to allow the results to be cached when sort_by is "random".

Fetches a list of {{ profiles }}.

{% set_profile %}

Saves custom properties on the profile that will be accessible whenever the current profile is logged in. The properties will be saved to the profile's attribute dictionary. Note that this is meaningless unless the user is logged in.

{% set_profile attributes %}
Parameters
attributes requireddictionary
Key:value pairs with unique keys. May use the variable arguments syntax.
Example Set the current user's profileAssociate the current user with a profile using set_profile so profile-specific content and settings apply.
Liquid
{%- if submission.is_valid -%}
	{%- var bestScoreName = form.name.value | classname | prepend:'bestscore-' -%}
	{%- var bestScore = submission.score | to_int -%}
	{%- var previousBestScore = profile.attributes[bestScoreName] | to_int -%}
	{%- if previousBestScore > bestScore -%}
		{%- set bestScore = previousBestScore -%}
	{%- endif -%}
	{%- set_profile last_score:submission.score &bestScoreName:bestScore -%}
{%- endif -%}

{% unset_profile %}

Removes custom properties from the attribute dictionary of the currently logged-in profile. Note that this is meaningless unless the user is logged in.

{% unset_profile attributes %}
Parameters
attributes requiredlist
One or more values. May use the variable arguments syntax.

There is no option to unset all attributes from a profile - attributes must be removed by name.

Example Clear the current profile with unset_profileClear the current profile with unset_profile so the user is no longer associated with that profile.

Simple Use Case

Liquid
{%- if request.query_params.hide_the_money -%}
	{%- unset_profile show_me_the_money -%}
{%- endif -%}

Removes the "show_me_the_money" profile property if the "hide_the_money" query parameter is present.

Unset Profile Properties Dynamically

Liquid
{%- var clearprops = request.query_params.clearprops | split: ',' | join:' ' -%}
{%- if clearprops is_valid -%}
	{%- unset_profile *clearprops -%}
{%- endif -%}

Checks if the "clearprops" query parameter was included in the request, and if it was, converts the comma-delimited list of property names to a space-delimited list and unsets the profile properties with those names using the expanded variable syntax.

Unset Multiple Profile Properties

Liquid
{%- if submission.is_valid and submission.score.value < 80 -%}
	{%- unset_profile passed_certification_exam user_is_certified_for_x -%}
{%- endif -%}

Unset multiple profile properties at the same time. In this example, the template will unset the "passed_certification_exam" and "user_is_certified_for_x" properties if the submission is valid and the score is less than 80.

{% set_profile_setting %}

Saves custom values to predefined profile settings that will be accessible whenever the current profile is logged in. Note that this is meaningless unless the user is logged in. Profile settings may include validation, in which case all settings will be validated before being set and any validation error will prevent the setting(s) from being set. Validation errors may optionally be output to a variable.

{% set_profile_setting [[var, set, or assign]? errors=variable]? properties %}
Parameters
var, set, or assign optionalkeyword
Optional. Specify either "var", "set" or "assign" to change which scope this {% set_profile_setting %} is stored on. "var" is the default behavior.
variable optionalvariable
The variable to save validation errors to. Validation errors will be specified as a list of Key:Value pairs, or null if there are no validation errors.
properties requireddictionary
Key:value pairs with unique keys. May use the variable arguments syntax. The settings to set on the profile. Each property key should match a setting id, and the property value will be used for the setting value
Example How to use the set_profile_setting methodSaves custom values to predefined profile settings that will be accessible whenever the current profile is logged in. Profile settings may include validation, in which case all settings will be validated before being set and any validation error will prevent the setting(s) from being set. Validation errors may optionally be output to a variable.

Simple Use Case

Liquid
{%- if submission.is_valid and submission.score > 70 -%}
	{%- set_profile_setting passed_test:'true' -%}
{%- endif -%}

Stores a value in the "passed_test" profile setting. Does not check if the user is currently logged in, verify that the "passed_test" setting is valid, or check for other errors. If the user is not logged in or the setting is not valid, it simply won't be saved.

Use Case with Validation

Liquid
{%- var new_layout = request.post_params['layout'] -%}
{%- var new_companyname = request.post_params['companyname'] -%}
{%- var new_description = request.post_params['description'] -%}
{%- set_profile_setting var errors = profile_errors layout:new_layout companyname:new_companyname description:new_description -%}
{%- if profile_errors -%}
	{%- for error in profile_errors -%}
		<p class="error">Error saving <strong>{{error.Key}}</strong>: {{error.Value}}</p>
	{%- endfor -%}
{%- endif -%}

Stores the values of the "layout", "companyname", and "description" form fields in the profile settings. If any of the settings are invalid, the errors are saved to the "profile_errors" variable and displayed to the user.

{% unset_profile_setting %}

Removes custom values from the profile settings for the currently logged-in profile. Note that this is meaningless unless the user is logged in. For settings with a default value this will reset them to the default, and for all other settings this will set them to empty/unselected/false. Profile settings may be required and include validation, in which case all settings will be validated before being removed and any validation error will prevent any settings from being set. Validation errors may optionally be output to a variable.

{% unset_profile_setting [[var, set, or assign]? errors=variable]? properties %}
Parameters
var, set, or assign optionalkeyword
Optional. Specify either "var", "set" or "assign" to change which scope this {% unset_profile_setting %} is stored on. "var" is the default behavior.
variable optionalvariable
The variable to save validation errors to. Validation errors will be specified as a list of Key:Value pairs, or null if there are no validation errors.
properties requiredlist
One or more values. May use the variable arguments syntax. The ids of the settings to remove from the profile

There is no option to unset all settings on a profile - settings must be unset by name.

Example Unset a profile settingRemove a profile setting value with unset_profile_setting so it is no longer stored for the current profile.
Liquid
{%- if request.post_params.clear_description -%}
	{%- unset_profile_setting description -%}
{%- endif -%}

Simple Use Case

Liquid
{%- if request.post_params.clear_description -%}
	{%- unset_profile_setting description -%}
{%- endif -%}

Unsets the "description" profile setting if the "clear_description" post parameter is present.

Unset Multiple Profile Settings at Once

Liquid
{%- if submission.is_valid and submission.score.value < 80 -%}
	{%- unset_profile_setting passed_certification_exam certification_category -%}
{%- endif -%}

Unset multiple profile settings at the same time. In this example, the template will unset the "passed_certification_exam" and "certification_category" settings if the submission is valid and the score is less than 80.

Unset Profile Settings Dynamically with Validation

Liquid
{%- var clearsettings = request.post_params.clearsettings | split: ',' | join:' ' -%}
{%- var profile_errors = null -%}
{%- if clearsettings is_valid -%}
	{%- unset_profile_setting set errors = profile_errors *clearsettings -%}
	{%- if profile_errors -%}
		{%- for error in profile_errors -%}
			<p class="error">Error clearing <strong>{{error.Key}}</strong>: {{error.Value}}</p>
		{%- endfor -%}
	{%- endif -%}
{%- endif -%}

Checks if the "clearsettings" post parameter was included in the request, and if it was, converts the comma-delimited list of setting names to a space-delimited list and unsets the profile settings with those names using the expanded variable syntax. If any of the settings are invalid, the errors are saved to the "profile_errors" variable and displayed to the user.