Log in

Customer Module

Address\Collection

Collection

This collection class manages groups of customer address records in Magento 2. Developers use it to retrieve and fi...

Attribute\Collection

Collection

This collection class is used to retrieve and manage customer attribute records from the database. Developers use t...

Customer\Collection

Collection

This collection class is used to retrieve and manipulate groups of customer records from the database in Magento 2....

Grid\Collection

Collection

This class provides a specialized collection for displaying customer data in the admin grid interface. It handles f...

Group\Collection

Collection

This collection class is used to retrieve and manipulate sets of customer groups from the database. Developers use...

Visitor\Collection

Collection

This collection class is used to retrieve and manage multiple visitor records from the database in Magento 2. Devel...

ElementFactory

Factory

This factory class creates form element objects for customer attributes based on their metadata. Developers use it...

FormFactory

Factory

This factory class creates instances of Customer Metadata Form objects that handle form validation and processing f...

Address

Helper

This helper class provides utility methods for managing customer address functionality in Magento 2. Developers use...

CurrentCustomer

Helper

This helper class provides a unified way to access the current customer's data in Magento 2, with special handling...

CurrentCustomerAddress

Helper

This helper class provides convenient access to the default billing and shipping addresses for the currently logged...

View

Helper

This helper class is responsible for generating a customer's full display name by concatenating their name componen...

AccountDelegationInterface

Interface

This interface provides a contract for delegating customer account creation actions from modules outside of the Cus...

AccountManagementInterface

Interface

This interface defines the core customer account management operations in Magento 2. Developers use this to create...

AddressMetadataInterface

Interface

This interface defines constants and contracts for working with customer address attribute metadata in Magento 2. D...

AddressMetadataManagementInterface

Interface

This interface defines the contract for managing metadata of customer address attributes in Magento 2. Developers u...

CustomerGroupConfigInterface

Interface

This interface defines the contract for managing system-level customer group configurations in Magento 2. Developer...

CustomerManagementInterface

Interface

This interface defines a contract for managing customer-related operations in Magento 2. Developers use this interf...

CustomerMetadataInterface

Interface

This interface defines constants and serves as a contract for retrieving metadata about customer attributes in Mage...

CustomerMetadataManagementInterface

Interface

This interface defines the contract for managing customer entity metadata and attributes in Magento 2. Developers u...

CustomerNameGenerationInterface

Interface

This interface defines a contract for generating a customer's full name by concatenating their name parts (first na...

AddressInterface

Interface

This interface defines the contract for customer address data objects in Magento 2. Developers use it to work with...

AddressSearchResultsInterface

Interface

This interface defines the contract for handling search results when querying customer addresses in Magento 2. Deve...

AttributeMetadataInterface

Interface

This interface defines the contract for working with customer attribute metadata in Magento 2. Developers use it to...

CustomerInterface

Interface

This interface defines the standard data structure for customer entities in Magento 2's API layer. Developers use t...

CustomerSearchResultsInterface

Interface

This interface defines the contract for customer search result collections in Magento 2. Developers use it when wor...

GroupExcludedWebsiteInterface

Interface

This interface defines the contract for managing customer group exclusions from specific websites in a multi-websit...

GroupInterface

Interface

This interface defines the contract for Customer Group data objects in Magento 2. Developers use this interface to...

GroupSearchResultsInterface

Interface

This interface defines the contract for search results when querying customer groups in Magento 2. Developers use t...

OptionInterface

Interface

This interface defines the structure for option objects used in customer attribute configurations, such as dropdown...

RegionInterface

Interface

This interface defines the contract for handling customer address region data in Magento 2. Developers use it when...

ValidationResultsInterface

Interface

This interface defines a contract for validation result objects in Magento 2's Customer module. Developers use this...

ValidationRuleInterface

Interface

This interface defines the contract for validation rules in Magento 2's Customer module. Developers use this to cre...

GroupManagementInterface

Interface

This interface defines the contract for managing customer groups in Magento 2. Developers use this to retrieve diff...

MetadataInterface

Interface

This interface provides methods to retrieve metadata information about customer-related attributes in Magento 2. De...

MetadataManagementInterface

Interface

This interface defines methods for managing customer attribute metadata in the Magento 2 admin grid. Developers use...

SessionCleanerInterface

Interface

This interface defines a contract for clearing customer session data in Magento 2. Developers would use implementat...

AddressModelInterface

Interface

This interface defines methods for working with multi-line street addresses in Magento 2's customer address system....

CustomAttributeListInterface

Interface

This interface defines a contract for retrieving custom attributes associated with customer addresses in Magento 2....

ValidatorInterface

Interface

This interface defines a contract for validating customer address data in Magento 2. Developers implement this inte...

AuthenticationInterface

Interface

This interface defines the contract for customer authentication operations in Magento 2. Developers use this to aut...

GroupSourceInterface

Interface

This interface defines a contract for classes that provide customer group options as a data source. Developers impl...

EmailNotificationInterface

Interface

This interface defines the contract for sending email notifications to customers in Magento 2. Developers use this...

RetrieverInterface

Interface

This interface defines a contract for retrieving the current customer's group ID from the session. Developers would...

AccountConfirmation

Model

This class determines whether email confirmation is required for customer accounts in Magento 2. Developers use it...

AccountManagement

Model

The AccountManagement class is the central service for managing customer account operations in Magento 2. Developer...

AccountManagementApi

Model

This class handles customer account creation specifically for external API requests (REST/SOAP). It extends the sta...

Authenticate

Model

This class handles customer authentication in Magento 2 by validating email and password credentials. Developers us...

Redirect

Model

This class manages customer redirect logic after login, registration, or authentication events in Magento 2. It det...

Address

Model

This class represents a customer address entity in Magento 2, handling the storage and management of customer billi...

AbstractAddress

Model

This abstract class serves as the base model for customer addresses in Magento 2, handling address data operations...

CountryModelsCache

Model

This class provides a caching mechanism for Country models in Magento 2, storing them by key to avoid repeatedly lo...

RegionModelsCache

Model

This class provides a temporary cache for storing and retrieving Region models during a single request lifecycle. D...

CompositeValidator

Model

This class implements the Composite design pattern to validate customer addresses by running multiple validators se...

Config

Model

This class manages customer address formatting configurations in Magento 2. Developers use it to retrieve different...

Converter

Model

This class converts customer address format configurations from XML DOM documents into PHP arrays. Developers inter...

Reader

Model

This class reads and loads customer address format configuration from XML files (address_formats.xml) across differ...

SchemaLocator

Model

This class locates the XSD schema file used to validate customer address format configuration XML files in Magento...

CustomAttributeList

Model

This class provides a list of custom attributes for customer addresses in Magento 2. Developers can use this class...

CustomAttributesProcessor

Model

This class processes custom attributes for customer addresses by filtering out attributes that shouldn't be visible...

CustomerAddressDataFormatter

Model

This class formats customer address data from an AddressInterface object into a standardized array structure. Devel...

CustomerAddressDataProvider

Model

This class retrieves and formats customer address data for display or processing in Magento 2. Developers use it wh...

DataProvider

Model

This DataProvider class supplies address data and metadata for the customer address edit/create forms in the Magent...

Form

Model

This class handles form operations for customer address data in Magento 2. Developers use it to validate, extract,...

Mapper

Model

This class converts a Customer Address data object into a flat associative array format. Developers use this when t...

AddressRegistry

Model

AddressRegistry acts as an in-memory cache for customer address models in Magento 2. Developers use this class to e...

AddressSearchResults

Model

This class serves as a data container for returning paginated customer address search results from repository queri...

Country

Model

This validator class ensures that customer addresses have valid country and region data according to Magento's dire...

Customer

Model

This validator ensures that a customer address being saved or updated belongs to the correct customer. It prevents...

General

Model

This class validates customer address data in Magento 2 by checking that required fields like firstname, lastname,...

Postcode

Model

This validator class checks if a postal code is valid for a customer address based on the country. Developers use t...

ContextPlugin

Model

This plugin intercepts every action in Magento 2 to set customer-specific context data (customer group ID and authe...

Attribute

Model

This class manages customer attributes in Magento 2, handling their lifecycle operations like saving, deleting, and...

AbstractData

Model

This abstract class serves as a base for customer attribute data models in Magento 2. Developers extend this class...

Boolean

Model

This class handles boolean-type customer attributes in Magento 2. Developers use it when working with yes/no or tru...

Date

Model

This class handles date attribute data specifically for customer entities in Magento 2. It extends the base EAV dat...

File

Model

This class handles file attribute data for customer entities in Magento 2. Developers use this model when working w...

Hidden

Model

This class handles hidden customer attribute data in Magento 2. Developers use this when working with customer attr...

Image

Model

This class handles customer attribute data for image file uploads in Magento 2. Developers use this class when work...

Multiline

Model

This class handles customer attributes that contain multiple lines of text data, such as street addresses. It exten...

Multiselect

Model

This class handles multi-select customer attribute data operations in Magento 2. Developers use this class when wor...

Postcode

Model

This class handles validation and data processing for postal/zip code attributes in customer addresses. Developers...

Select

Model

This class handles select/dropdown attribute data for customer entities in Magento 2. Developers use this when work...

Text

Model

This class handles text-type customer attributes in Magento 2, such as first name, last name, or custom text fields...

Textarea

Model

This class handles textarea-type customer attributes in Magento 2, extending the base EAV textarea data model. Deve...

AttributeMetadataConverter

Model

This class converts Magento EAV attribute models into API-compatible AttributeMetadata data objects for customer at...

AttributeMetadataDataProvider

Model

This class provides a centralized way to retrieve customer and customer address attribute metadata in Magento 2. De...

AttributeMetadataResolver

Model

This class builds metadata configuration for customer and customer address attributes in Magento 2's UI components....

AttributeWebsiteRequired

Model

This class retrieves information about which customer attributes are required on specific websites in a multi-websi...

Authentication

Model

This class handles customer authentication security in Magento 2, managing password verification and account lockou...

CustomerSessionUserContext

Model

This class provides a way to identify and retrieve information about the currently logged-in customer through their...

Customer

Model

This class extends the standard Customer model specifically for backend (admin panel) operations. It overrides the...

GroupExcludedWebsiteCache

Model

This class provides in-memory caching for customer group and excluded website relationships in Magento 2. Developer...

Notification

Model

This class defines a custom cache type for customer notifications in Magento 2. Developers use this cache type to s...

ConfigPlugin

Model

This plugin intercepts the cart sidebar configuration to add customer-specific data to the cart's frontend configur...

ConfigProvider

Model

This class provides customer-related configuration data to the checkout process in Magento 2. Developers use it to...

Share

Model

This class manages customer account sharing configuration in Magento 2, determining whether customer accounts are s...

FilterConditionType

Model

This class provides filter condition type options for customer-related filtering operations in Magento 2. Developer...

Group

Model

This class provides a source of customer group options for configuration fields in the Magento admin panel. Develop...

Context

Model

This class defines constants used for managing customer-related cache contexts in Magento 2. Developers use these c...

Customer

Model

The Customer model class represents a customer entity in Magento 2 and provides methods for managing customer data,...

Authorization

Model

This class verifies if a logged-in customer has authorization to access resources in the current store. Developers...

AuthorizationComposite

Model

This class implements a composite authorization pattern that checks multiple authorization rules in sequence for cu...

CustomerAuthUpdate

Model

This model handles updating customer authentication data in Magento 2, specifically managing login failure tracking...

CredentialsValidator

Model

This class validates customer credentials to ensure password security requirements are met. Developers use this cla...

DataProvider

Model

This class provides customer data for Magento 2's admin UI components, specifically for customer edit forms. Develo...

DataProviderWithDefaultAddresses

Model

This class provides customer data for UI components in the Magento 2 admin panel, specifically for customer edit fo...

CustomerExtractor

Model

CustomerExtractor is a utility model that extracts and validates customer data from HTTP requests and transforms it...

CustomerGroupConfig

Model

This class manages system configuration operations for customer groups in Magento 2. It allows developers to progra...

CustomerIdProvider

Model

This class provides a simple way to retrieve the customer ID from the current HTTP request. Developers use it when...

CustomerManagement

Model

This class provides customer management functionality, specifically retrieving the total count of customers in the...

Mapper

Model

This class converts Customer data objects into flat arrays, making it easier to work with customer data in forms, t...

NotificationStorage

Model

This class manages temporary customer notifications using Magento's cache system. Developers use it to store, check...

CustomerRegistry

Model

CustomerRegistry acts as an in-memory cache for Customer models in Magento 2, storing loaded customers by ID and em...

CustomerSearchResults

Model

This class is a Data Transfer Object (DTO) that holds the results of customer search operations in Magento 2. Devel...

Group

Model

This class provides a source model for retrieving customer groups as option arrays, commonly used in dropdowns, mul...

Address

Model

This is a data model class that represents a customer address in Magento 2. Developers use this class to store and...

AttributeMetadata

Model

This class is a data model that represents metadata for customer attributes in Magento 2. Developers use it to retr...

Customer

Model

This is the Customer Data Model class that represents a customer entity in Magento 2. Developers use this class to...

CustomerSecure

Model

CustomerSecure is a data model that stores sensitive customer information that should not be publicly exposed throu...

Group

Model

This is a data model class that represents a Customer Group in Magento 2. Developers use this class to work with cu...

GroupExcludedWebsite

Model

This class represents a data model for managing customer group exclusions from specific websites in a multi-website...

Option

Model

This class represents a single option for customer EAV attributes, such as dropdown or multi-select field choices....

Region

Model

This class represents a geographical region (state/province) data model for customer addresses in Magento 2. Develo...

ValidationResults

Model

This class represents the result of a validation operation in Magento 2's Customer module. Developers use it to che...

ValidationRule

Model

This class represents a single validation rule for customer attributes in Magento 2. Developers use it to define an...

AccountDelegation

Model

This class handles the delegation of customer account creation operations in Magento 2. It stores new customer data...

NewOperation

Model

This is a data transfer object (DTO) that encapsulates information needed when creating a new customer account thro...

Storage

Model

This class manages temporary storage of customer registration data during delegated account creation operations. De...

EmailNotification

Model

This class handles sending transactional emails to customers for account-related events such as registration, passw...

FileProcessor

Model

This class handles file upload operations for customer and customer address attributes in Magento 2. Developers use...

FileUploader

Model

This class handles file uploads for customer and address attributes in Magento 2. Developers use it to validate and...

FileUploaderDataResolver

Model

This class prepares file and image upload data for customer and customer address attributes in Magento 2's admin UI...

ConfirmCustomerByToken

Model

This class handles customer account confirmation during the password reset process in Magento 2. Developers use thi...

GetCustomerByToken

Model

This class retrieves a customer account using a password reset token. Developers would use this when implementing p...

Form

Model

This class handles customer form operations in Magento 2, extending the base EAV Form model. Developers use this wh...

Group

Model

This class represents a customer group in Magento 2, which is used to categorize customers for pricing, tax rules,...

GroupManagement

Model

This class manages customer group operations in Magento 2, providing methods to retrieve different types of custome...

GroupRegistry

Model

The GroupRegistry acts as a centralized cache for Customer Group models in Magento 2. It prevents repeated database...

Resolver

Model

This class provides a lightweight service to retrieve a customer's group ID based on their customer ID. Developers...

Retriever

Model

This class retrieves the current customer's group ID from the customer session. Developers would use this when they...

GroupSearchResults

Model

This class is a Data Transfer Object (DTO) that holds search results when querying for customer groups in Magento 2...

AttributeProvider

Model

This class provides EAV attributes specifically for customer address entities in Magento 2's indexing system. It ex...

Filter

Model

This class filters customer attributes based on whether they exist in the customer grid index table. When the custo...

AttributeProvider

Model

This class provides dynamic EAV (Entity-Attribute-Value) attribute field definitions for the customer grid indexer...

CustomerGroupDimensionProvider

Model

This class provides customer group dimensions for Magento 2's multidimensional indexing system. Developers would us...

Processor

Model

This class serves as a processor for the Customer Grid indexer in Magento 2. Developers use this processor to trigg...

Source

Model

This class serves as a data source provider for the customer_grid indexer in Magento 2. It generates batches of cus...

DepersonalizePlugin

Model

This plugin clears sensitive customer session data (like customer group ID and form keys) when serving cached pages...

Log

Model

This class serves as a data container (value object) for storing customer activity tracking information in Magento...

Logger

Model

The Logger class manages customer activity tracking in Magento 2 by recording and retrieving login, logout, and vis...

AddressCachedMetadata

Model

This class provides cached access to customer address attribute metadata in Magento 2. It acts as a performance opt...

AddressMetadata

Model

This class provides metadata information about customer address attributes in Magento 2. Developers use it to retri...

AddressMetadataManagement

Model

No explanation available yet.

AttributeMetadataCache

Model

This class manages caching for customer attribute metadata in Magento 2. It stores and retrieves attribute configur...

AttributeMetadataHydrator

Model

This class converts customer attribute metadata between array format and AttributeMetadataInterface objects in Mage...

AttributeResolver

Model

This class resolves and retrieves the full Attribute model object from an AttributeMetadataInterface data object. D...

CachedMetadata

Model

This class acts as a caching wrapper for customer and customer address attribute metadata in Magento 2. It intercep...

CustomerCachedMetadata

Model

This class provides a cached version of customer attribute metadata to improve performance by reducing database que...

CustomerMetadata

Model

This class provides access to customer entity attribute metadata in Magento 2. Developers use it to retrieve inform...

CustomerMetadataManagement

Model

This class manages customer custom attribute metadata, specifically determining if attributes can be used in admin...

Form

Model

This class handles customer and address form metadata operations in Magento 2. Developers use it to retrieve form a...

AbstractData

Model

This abstract class serves as the base for handling customer and customer address attribute data in Magento 2 forms...

Boolean

Model

This class handles boolean (Yes/No) customer attribute form elements in Magento 2. It extends the Select form eleme...

Date

Model

This class handles date attribute data for customer forms in Magento 2. It manages extracting date values from requ...

File

Model

This class handles file upload operations for customer attributes in Magento 2. Developers use it to validate, extr...

Hidden

Model

This class handles hidden form fields in Magento 2's customer metadata forms. Developers use it when processing cus...

Image

Model

This class handles image attribute uploads for Magento 2 customer and customer address forms. It validates uploaded...

Multiline

Model

This class handles the processing and validation of multiline customer attributes in Magento 2 forms, such as stree...

Multiselect

Model

This class handles the processing of multiselect form elements in Magento 2's customer attribute system. It manages...

Postcode

Model

This class handles the validation of postal/zip codes for customer addresses in Magento 2. It extends the Text form...

Select

Model

This class handles select dropdown form elements for customer attributes in Magento 2. Developers use it to extract...

Text

Model

This class handles validation, extraction, and formatting of text-based customer attribute form fields in Magento 2...

Textarea

Model

This class handles textarea form elements for customer attributes in Magento 2. It extends the Text class to provid...

Validator

Model

This class validates customer attribute data against defined EAV attribute rules and constraints in Magento 2. Deve...

Options

Model

This class provides customer name prefix and suffix configuration options (like Mr., Mrs., Jr., Sr.) for forms thro...

Registration

Model

This class determines whether customer registration is allowed on the Magento store. Developers can use this model...

Region

Model

This class renders the region/state field in customer address forms throughout Magento 2. It intelligently displays...

Address

Model

This class manages database operations for customer address entities in Magento 2. Developers use this resource mod...

DeleteRelation

Model

This class handles the cleanup of default billing and shipping address references when a customer address is delete...

Relation

Model

This class manages the relationship between customer addresses and their parent customer entity, specifically handl...

AddressRepository

Model

The AddressRepository class is the main entry point for managing customer addresses in Magento 2. Developers use th...

Attribute

Model

This resource model manages database operations for customer attributes in Magento 2's EAV (Entity-Attribute-Value)...

Customer

Model

This class is the resource model for customer entities in Magento 2, responsible for database operations related to...

Grid

Model

This deprecated class manages the synchronization of the customer grid in Magento 2's admin panel. It identifies cu...

Relation

Model

This class handles the relationship between Customer entities and their associated Address records during save oper...

CustomerRepository

Model

This class provides CRUD (Create, Read, Update, Delete) operations for customer entities in Magento 2. Developers u...

Attribute

Model

This resource model manages the database operations for customer form attributes in Magento 2. It handles the stora...

Group

Model

This resource model handles database operations for customer groups in Magento 2. Developers use this class when th...

GroupExcludedWebsite

Model

This resource model manages database operations for customer group exclusions from specific websites in Magento's m...

GroupExcludedWebsiteRepository

Model

This repository class manages the relationship between customer groups and websites that should be excluded from th...

GetCustomerGroupCodesByIds

Model

This class retrieves customer group codes based on provided customer group IDs. Developers use it when they need to...

GroupRepository

Model

This class manages CRUD (Create, Read, Update, Delete) operations for customer groups in Magento 2. Developers use...

Resolver

Model

This class retrieves a customer's group ID directly from the database using their customer ID. Developers use this...

Visitor

Model

This resource model manages database operations for the customer_visitor table in Magento 2, which tracks visitor s...

Session

Model

This class manages the customer session in Magento 2, handling customer login/logout operations, storing customer d...

SessionCleaner

Model

This class is responsible for clearing all session data associated with a specific customer, effectively logging th...

Storage

Model

This class manages storage for customer session data in Magento 2. It extends the framework's base storage class an...

CutoffValidator

Model

This validator ensures customer sessions remain valid by checking if a session was created before a cutoff timestam...

SetCustomerStore

Model

This class sets the current store context for a customer based on their website or store ID. Developers would use t...

RedirectDataPostprocessor

Model

This class handles customer authentication when switching between different store views in a multi-store Magento se...

RedirectDataPreprocessor

Model

This class prepares customer data when a logged-in user switches between different store views in a Magento multi-s...

Url

Model

This class generates URLs for all customer-related pages in Magento 2, such as login, registration, account dashboa...

File

Model

This class validates file uploads for customer addresses to prevent security vulnerabilities like path traversal at...

City

Model

This validator ensures that customer city names contain only valid characters (letters, diacritics, apostrophes, hy...

Dob

Model

This validator ensures that a customer's date of birth is not set to a future date. Developers use this class durin...

Name

Model

This validator class validates customer name fields (first name, last name, and middle name) against a specific pat...

Street

Model

This validator class ensures that customer street address fields contain only allowed characters like letters, numb...

Telephone

Model

This validator class ensures that customer telephone numbers contain only valid characters (digits, spaces, plus si...

Vat

Model

This class handles VAT (Value Added Tax) number validation for EU customers in Magento 2. Developers use it to vali...

Visitor

Model

The Visitor model tracks and manages visitor sessions in Magento 2, storing information about both guest visitors a...

ParamOverriderCustomerGroupId

Model

This class automatically replaces placeholder values like '%customer_group_id%' in Web API requests with the actual...

ParamOverriderCustomerStoreId

Model

This class automatically replaces the placeholder '%customer_store_id%' with the actual store ID of the currently a...

ParamOverriderCustomerWebsiteId

Model

This class automatically replaces the placeholder '%customer_website_id%' with the actual website ID of the current...

AddressRepositoryInterface

Repository

This interface defines the contract for managing customer address data in Magento 2. Developers use this repository...

CustomerRepositoryInterface

Repository

This interface defines the contract for managing customer data in Magento 2, providing standard CRUD (Create, Read,...

GroupExcludedWebsiteRepositoryInterface

Repository

This repository interface manages the relationship between customer groups and websites that are excluded from thos...

GroupRepositoryInterface

Repository

This interface defines the contract for managing customer groups in Magento 2, providing CRUD (Create, Read, Update...