User Object
Explore the properties and methods available in the User object for Aikeedo themes.
The user
object is a fundamental component in Aikeedo themes, providing access to essential user information when a user is logged into their account. This object is globally accessible, allowing you to easily incorporate user-specific data and functionality into your theme.
Availability
The user
object is available globally when a user is logged in. If no user is logged in, the object will be undefined. Always check for the existence of the user
object before attempting to access its properties.
It’s a good practice to use conditional checks when working with the user
object to ensure your theme functions correctly for both logged-in and guest users.
Properties
The user
object contains the following properties:
A unique identifier for the user, always in UUID version 4 format (e.g., “01895d81-4963-71b4-b591-8404987d6954”).
The user’s role in the system. Possible values are:
admin
: Administrator role with full system accessuser
: Standard user role with limited permissions
The user’s email address.
The user’s first name.
The user’s last name.
The user’s preferred language code (e.g., “en-US”).
Indicates whether the user has set a password. Users who signed up using 3rd party services like Google will not have a password.
URL to the user’s avatar image.
Unix timestamp of when the user account was created.
Unix timestamp of the last update to the user account. While this field always exists, its value may be null if the user account has never been updated.
Indicates whether the user’s email has been verified.
The user’s API key (partially masked for security).
The user’s affiliate object. See Affiliate Object for more details on the properties of this object.
The user’s active workspace object. See Workspace Object for more details on the properties of this object.
An array of workspace objects that the user is a member of, excluding workspaces owned by the user. Each object in this array represents a workspace where the user has membership but not ownership. See Workspace Object for more details on the properties of these objects.
An array of workspace objects that the user owns. See Workspace Object for more details on the properties of these objects.
Was this page helpful?