Customer Module
AccountConfirmation
This class determines whether email confirmation is required for customer accounts in Magento 2. Developers use it...
AccountManagement
The AccountManagement class is the central service for managing customer account operations in Magento 2. Developer...
AccountManagementApi
This class handles customer account creation specifically for external API requests (REST/SOAP). It extends the sta...
AccountManagement\Authenticate
This class handles customer authentication in Magento 2 by validating email and password credentials. Developers us...
Account\Redirect
This class manages customer redirect logic after login, registration, or authentication events in Magento 2. It det...
Address
This class represents a customer address entity in Magento 2, handling the storage and management of customer billi...
Address
This helper class provides utility methods for managing customer address functionality in Magento 2. Developers use...
AddressRegistry
AddressRegistry acts as an in-memory cache for customer address models in Magento 2. Developers use this class to e...
AddressSearchResults
This class serves as a data container for returning paginated customer address search results from repository queri...
Address\AbstractAddress
This abstract class serves as the base model for customer addresses in Magento 2, handling address data operations...
Address\AbstractAddress\CountryModelsCache
This class provides a caching mechanism for Country models in Magento 2, storing them by key to avoid repeatedly lo...
Address\AbstractAddress\RegionModelsCache
This class provides a temporary cache for storing and retrieving Region models during a single request lifecycle. D...
Address\CompositeValidator
This class implements the Composite design pattern to validate customer addresses by running multiple validators se...
Address\Config
This class manages customer address formatting configurations in Magento 2. Developers use it to retrieve different...
Address\Config\Converter
This class converts customer address format configurations from XML DOM documents into PHP arrays. Developers inter...
Address\Config\Reader
This class reads and loads customer address format configuration from XML files (address_formats.xml) across differ...
Address\Config\SchemaLocator
This class locates the XSD schema file used to validate customer address format configuration XML files in Magento...
Address\CustomAttributeList
This class provides a list of custom attributes for customer addresses in Magento 2. Developers can use this class...
Address\CustomAttributesProcessor
This class processes custom attributes for customer addresses by filtering out attributes that shouldn't be visible...
Address\CustomerAddressDataFormatter
This class formats customer address data from an AddressInterface object into a standardized array structure. Devel...
Address\CustomerAddressDataProvider
This class retrieves and formats customer address data for display or processing in Magento 2. Developers use it wh...
Address\DataProvider
This DataProvider class supplies address data and metadata for the customer address edit/create forms in the Magent...
Address\Form
This class handles form operations for customer address data in Magento 2. Developers use it to validate, extract,...
Address\Mapper
This class converts a Customer Address data object into a flat associative array format. Developers use this when t...
Address\Validator\Country
This validator class ensures that customer addresses have valid country and region data according to Magento's dire...
Address\Validator\Customer
This validator ensures that a customer address being saved or updated belongs to the correct customer. It prevents...
Address\Validator\General
This class validates customer address data in Magento 2 by checking that required fields like firstname, lastname,...
Address\Validator\Postcode
This validator class checks if a postal code is valid for a customer address based on the country. Developers use t...
Api\AccountDelegationInterface
This interface provides a contract for delegating customer account creation actions from modules outside of the Cus...
Api\AccountManagementInterface
This interface defines the core customer account management operations in Magento 2. Developers use this to create...
Api\AddressMetadataInterface
This interface defines constants and contracts for working with customer address attribute metadata in Magento 2. D...
Api\AddressMetadataManagementInterface
This interface defines the contract for managing metadata of customer address attributes in Magento 2. Developers u...
Api\AddressRepositoryInterface
This interface defines the contract for managing customer address data in Magento 2. Developers use this repository...
Api\CustomerGroupConfigInterface
This interface defines the contract for managing system-level customer group configurations in Magento 2. Developer...
Api\CustomerManagementInterface
This interface defines a contract for managing customer-related operations in Magento 2. Developers use this interf...
Api\CustomerMetadataInterface
This interface defines constants and serves as a contract for retrieving metadata about customer attributes in Mage...
Api\CustomerMetadataManagementInterface
This interface defines the contract for managing customer entity metadata and attributes in Magento 2. Developers u...
Api\CustomerNameGenerationInterface
This interface defines a contract for generating a customer's full name by concatenating their name parts (first na...
Api\CustomerRepositoryInterface
This interface defines the contract for managing customer data in Magento 2, providing standard CRUD (Create, Read,...
Api\Data\AddressInterface
This interface defines the contract for customer address data objects in Magento 2. Developers use it to work with...
Api\Data\AddressSearchResultsInterface
This interface defines the contract for handling search results when querying customer addresses in Magento 2. Deve...
Api\Data\AttributeMetadataInterface
This interface defines the contract for working with customer attribute metadata in Magento 2. Developers use it to...
Api\Data\CustomerInterface
This interface defines the standard data structure for customer entities in Magento 2's API layer. Developers use t...
Api\Data\CustomerSearchResultsInterface
This interface defines the contract for customer search result collections in Magento 2. Developers use it when wor...
Api\Data\GroupExcludedWebsiteInterface
This interface defines the contract for managing customer group exclusions from specific websites in a multi-websit...
Api\Data\GroupInterface
This interface defines the contract for Customer Group data objects in Magento 2. Developers use this interface to...
Api\Data\GroupSearchResultsInterface
This interface defines the contract for search results when querying customer groups in Magento 2. Developers use t...
Api\Data\OptionInterface
This interface defines the structure for option objects used in customer attribute configurations, such as dropdown...
Api\Data\RegionInterface
This interface defines the contract for handling customer address region data in Magento 2. Developers use it when...
Api\Data\ValidationResultsInterface
This interface defines a contract for validation result objects in Magento 2's Customer module. Developers use this...
Api\Data\ValidationRuleInterface
This interface defines the contract for validation rules in Magento 2's Customer module. Developers use this to cre...
Api\GroupExcludedWebsiteRepositoryInterface
This repository interface manages the relationship between customer groups and websites that are excluded from thos...
Api\GroupManagementInterface
This interface defines the contract for managing customer groups in Magento 2. Developers use this to retrieve diff...
Api\GroupRepositoryInterface
This interface defines the contract for managing customer groups in Magento 2, providing CRUD (Create, Read, Update...
Api\MetadataInterface
This interface provides methods to retrieve metadata information about customer-related attributes in Magento 2. De...
Api\MetadataManagementInterface
This interface defines methods for managing customer attribute metadata in the Magento 2 admin grid. Developers use...
Api\SessionCleanerInterface
This interface defines a contract for clearing customer session data in Magento 2. Developers would use implementat...
App\Action\ContextPlugin
This plugin intercepts every action in Magento 2 to set customer-specific context data (customer group ID and authe...
Attribute
This class manages customer attributes in Magento 2, handling their lifecycle operations like saving, deleting, and...
AttributeMetadataConverter
This class converts Magento EAV attribute models into API-compatible AttributeMetadata data objects for customer at...
AttributeMetadataDataProvider
This class provides a centralized way to retrieve customer and customer address attribute metadata in Magento 2. De...
AttributeMetadataResolver
This class builds metadata configuration for customer and customer address attributes in Magento 2's UI components....
AttributeWebsiteRequired
This class retrieves information about which customer attributes are required on specific websites in a multi-websi...
Attribute\Data\AbstractData
This abstract class serves as a base for customer attribute data models in Magento 2. Developers extend this class...
Attribute\Data\Boolean
This class handles boolean-type customer attributes in Magento 2. Developers use it when working with yes/no or tru...
Attribute\Data\Date
This class handles date attribute data specifically for customer entities in Magento 2. It extends the base EAV dat...
Attribute\Data\File
This class handles file attribute data for customer entities in Magento 2. Developers use this model when working w...
Attribute\Data\Hidden
This class handles hidden customer attribute data in Magento 2. Developers use this when working with customer attr...
Attribute\Data\Image
This class handles customer attribute data for image file uploads in Magento 2. Developers use this class when work...
Attribute\Data\Multiline
This class handles customer attributes that contain multiple lines of text data, such as street addresses. It exten...
Attribute\Data\Multiselect
This class handles multi-select customer attribute data operations in Magento 2. Developers use this class when wor...
Attribute\Data\Postcode
This class handles validation and data processing for postal/zip code attributes in customer addresses. Developers...
Attribute\Data\Select
This class handles select/dropdown attribute data for customer entities in Magento 2. Developers use this when work...
Attribute\Data\Text
This class handles text-type customer attributes in Magento 2, such as first name, last name, or custom text fields...
Attribute\Data\Textarea
This class handles textarea-type customer attributes in Magento 2, extending the base EAV textarea data model. Deve...
Authentication
This class handles customer authentication security in Magento 2, managing password verification and account lockou...
Authorization\CustomerSessionUserContext
This class provides a way to identify and retrieve information about the currently logged-in customer through their...
Backend\Customer
This class extends the standard Customer model specifically for backend (admin panel) operations. It overrides the...
Cache\GroupExcludedWebsiteCache
This class provides in-memory caching for customer group and excluded website relationships in Magento 2. Developer...
Cache\Type\Notification
This class defines a custom cache type for customer notifications in Magento 2. Developers use this cache type to s...
Cart\ConfigPlugin
This plugin intercepts the cart sidebar configuration to add customer-specific data to the cart's frontend configur...
Checkout\ConfigProvider
This class provides customer-related configuration data to the checkout process in Magento 2. Developers use it to...
Config\Share
This class manages customer account sharing configuration in Magento 2, determining whether customer accounts are s...
Config\Source\FilterConditionType
This class provides filter condition type options for customer-related filtering operations in Magento 2. Developer...
Config\Source\Group
This class provides a source of customer group options for configuration fields in the Magento admin panel. Develop...
Context
This class defines constants used for managing customer-related cache contexts in Magento 2. Developers use these c...
Customer
The Customer model class represents a customer entity in Magento 2 and provides methods for managing customer data,...
CustomerAuthUpdate
This model handles updating customer authentication data in Magento 2, specifically managing login failure tracking...
CustomerExtractor
CustomerExtractor is a utility model that extracts and validates customer data from HTTP requests and transforms it...
CustomerGroupConfig
This class manages system configuration operations for customer groups in Magento 2. It allows developers to progra...
CustomerIdProvider
This class provides a simple way to retrieve the customer ID from the current HTTP request. Developers use it when...
CustomerManagement
This class provides customer management functionality, specifically retrieving the total count of customers in the...
CustomerRegistry
CustomerRegistry acts as an in-memory cache for Customer models in Magento 2, storing loaded customers by ID and em...
CustomerSearchResults
This class is a Data Transfer Object (DTO) that holds the results of customer search operations in Magento 2. Devel...
Customer\Authorization
This class verifies if a logged-in customer has authorization to access resources in the current store. Developers...
Customer\AuthorizationComposite
This class implements a composite authorization pattern that checks multiple authorization rules in sequence for cu...
Customer\CredentialsValidator
This class validates customer credentials to ensure password security requirements are met. Developers use this cla...
Customer\DataProvider
This class provides customer data for Magento 2's admin UI components, specifically for customer edit forms. Develo...
Customer\DataProviderWithDefaultAddresses
This class provides customer data for UI components in the Magento 2 admin panel, specifically for customer edit fo...
Customer\Mapper
This class converts Customer data objects into flat arrays, making it easier to work with customer data in forms, t...
Customer\NotificationStorage
This class manages temporary customer notifications using Magento's cache system. Developers use it to store, check...
Customer\Source\Group
This class provides a source model for retrieving customer groups as option arrays, commonly used in dropdowns, mul...
Data\Address
This is a data model class that represents a customer address in Magento 2. Developers use this class to store and...
Data\AttributeMetadata
This class is a data model that represents metadata for customer attributes in Magento 2. Developers use it to retr...
Data\Customer
This is the Customer Data Model class that represents a customer entity in Magento 2. Developers use this class to...
Data\CustomerSecure
CustomerSecure is a data model that stores sensitive customer information that should not be publicly exposed throu...
Data\Group
This is a data model class that represents a Customer Group in Magento 2. Developers use this class to work with cu...
Data\GroupExcludedWebsite
This class represents a data model for managing customer group exclusions from specific websites in a multi-website...
Data\Option
This class represents a single option for customer EAV attributes, such as dropdown or multi-select field choices....
Data\Region
This class represents a geographical region (state/province) data model for customer addresses in Magento 2. Develo...
Data\ValidationResults
This class represents the result of a validation operation in Magento 2's Customer module. Developers use it to che...
Data\ValidationRule
This class represents a single validation rule for customer attributes in Magento 2. Developers use it to define an...
Delegation\AccountDelegation
This class handles the delegation of customer account creation operations in Magento 2. It stores new customer data...
Delegation\Data\NewOperation
This is a data transfer object (DTO) that encapsulates information needed when creating a new customer account thro...
Delegation\Storage
This class manages temporary storage of customer registration data during delegated account creation operations. De...
EmailNotification
This class handles sending transactional emails to customers for account-related events such as registration, passw...
FileProcessor
This class handles file upload operations for customer and customer address attributes in Magento 2. Developers use...
FileUploader
This class handles file uploads for customer and address attributes in Magento 2. Developers use it to validate and...
FileUploaderDataResolver
This class prepares file and image upload data for customer and customer address attributes in Magento 2's admin UI...
ForgotPasswordToken\ConfirmCustomerByToken
This class handles customer account confirmation during the password reset process in Magento 2. Developers use thi...
ForgotPasswordToken\GetCustomerByToken
This class retrieves a customer account using a password reset token. Developers would use this when implementing p...
Form
This class handles customer form operations in Magento 2, extending the base EAV Form model. Developers use this wh...
Group
This class represents a customer group in Magento 2, which is used to categorize customers for pricing, tax rules,...
GroupManagement
This class manages customer group operations in Magento 2, providing methods to retrieve different types of custome...
GroupRegistry
The GroupRegistry acts as a centralized cache for Customer Group models in Magento 2. It prevents repeated database...
GroupSearchResults
This class is a Data Transfer Object (DTO) that holds search results when querying for customer groups in Magento 2...
Group\Resolver
This class provides a lightweight service to retrieve a customer's group ID based on their customer ID. Developers...
Group\Retriever
This class retrieves the current customer's group ID from the customer session. Developers would use this when they...
Indexer\Address\AttributeProvider
This class provides EAV attributes specifically for customer address entities in Magento 2's indexing system. It ex...
Indexer\AttributeProvider
This class provides dynamic EAV (Entity-Attribute-Value) attribute field definitions for the customer grid indexer...
Indexer\Attribute\Filter
This class filters customer attributes based on whether they exist in the customer grid index table. When the custo...
Indexer\CustomerGroupDimensionProvider
This class provides customer group dimensions for Magento 2's multidimensional indexing system. Developers would us...
Indexer\Processor
This class serves as a processor for the Customer Grid indexer in Magento 2. Developers use this processor to trigg...
Indexer\Source
This class serves as a data source provider for the customer_grid indexer in Magento 2. It generates batches of cus...
Layout\DepersonalizePlugin
This plugin clears sensitive customer session data (like customer group ID and form keys) when serving cached pages...
Log
This class serves as a data container (value object) for storing customer activity tracking information in Magento...
Logger
The Logger class manages customer activity tracking in Magento 2 by recording and retrieving login, logout, and vis...
Metadata\AddressCachedMetadata
This class provides cached access to customer address attribute metadata in Magento 2. It acts as a performance opt...
Metadata\AddressMetadata
This class provides metadata information about customer address attributes in Magento 2. Developers use it to retri...
Metadata\AddressMetadataManagement
No explanation available yet.
Metadata\AttributeMetadataCache
This class manages caching for customer attribute metadata in Magento 2. It stores and retrieves attribute configur...
Metadata\AttributeMetadataHydrator
This class converts customer attribute metadata between array format and AttributeMetadataInterface objects in Mage...
Metadata\AttributeResolver
This class resolves and retrieves the full Attribute model object from an AttributeMetadataInterface data object. D...
Metadata\CachedMetadata
This class acts as a caching wrapper for customer and customer address attribute metadata in Magento 2. It intercep...
Metadata\CustomerCachedMetadata
This class provides a cached version of customer attribute metadata to improve performance by reducing database que...
Metadata\CustomerMetadata
This class provides access to customer entity attribute metadata in Magento 2. Developers use it to retrieve inform...
Metadata\CustomerMetadataManagement
This class manages customer custom attribute metadata, specifically determining if attributes can be used in admin...
Metadata\Form
This class handles customer and address form metadata operations in Magento 2. Developers use it to retrieve form a...
Metadata\Form\AbstractData
This abstract class serves as the base for handling customer and customer address attribute data in Magento 2 forms...
Metadata\Form\Boolean
This class handles boolean (Yes/No) customer attribute form elements in Magento 2. It extends the Select form eleme...
Metadata\Form\Date
This class handles date attribute data for customer forms in Magento 2. It manages extracting date values from requ...
Metadata\Form\File
This class handles file upload operations for customer attributes in Magento 2. Developers use it to validate, extr...
Metadata\Form\Hidden
This class handles hidden form fields in Magento 2's customer metadata forms. Developers use it when processing cus...
Metadata\Form\Image
This class handles image attribute uploads for Magento 2 customer and customer address forms. It validates uploaded...
Metadata\Form\Multiline
This class handles the processing and validation of multiline customer attributes in Magento 2 forms, such as stree...
Metadata\Form\Multiselect
This class handles the processing of multiselect form elements in Magento 2's customer attribute system. It manages...
Metadata\Form\Postcode
This class handles the validation of postal/zip codes for customer addresses in Magento 2. It extends the Text form...
Metadata\Form\Select
This class handles select dropdown form elements for customer attributes in Magento 2. Developers use it to extract...
Metadata\Form\Text
This class handles validation, extraction, and formatting of text-based customer attribute form fields in Magento 2...
Metadata\Form\Textarea
This class handles textarea form elements for customer attributes in Magento 2. It extends the Text class to provid...
Metadata\Validator
This class validates customer attribute data against defined EAV attribute rules and constraints in Magento 2. Deve...
Model\Address\AddressModelInterface
This interface defines methods for working with multi-line street addresses in Magento 2's customer address system....
Model\Address\CustomAttributeListInterface
This interface defines a contract for retrieving custom attributes associated with customer addresses in Magento 2....
Model\Address\ValidatorInterface
This interface defines a contract for validating customer address data in Magento 2. Developers implement this inte...
Model\AuthenticationInterface
This interface defines the contract for customer authentication operations in Magento 2. Developers use this to aut...
Model\Customer\Source\GroupSourceInterface
This interface defines a contract for classes that provide customer group options as a data source. Developers impl...
Model\EmailNotificationInterface
This interface defines the contract for sending email notifications to customers in Magento 2. Developers use this...
Model\Group\RetrieverInterface
This interface defines a contract for retrieving the current customer's group ID from the session. Developers would...
Model\Metadata\ElementFactory
This factory class creates form element objects for customer attributes based on their metadata. Developers use it...
Model\Metadata\FormFactory
This factory class creates instances of Customer Metadata Form objects that handle form validation and processing f...
Model\ResourceModel\Address\Collection
This collection class manages groups of customer address records in Magento 2. Developers use it to retrieve and fi...
Model\ResourceModel\Attribute\Collection
This collection class is used to retrieve and manage customer attribute records from the database. Developers use t...
Model\ResourceModel\Customer\Collection
This collection class is used to retrieve and manipulate groups of customer records from the database in Magento 2....
Model\ResourceModel\Grid\Collection
This class provides a specialized collection for displaying customer data in the admin grid interface. It handles f...
Model\ResourceModel\Group\Collection
This collection class is used to retrieve and manipulate sets of customer groups from the database. Developers use...
Model\ResourceModel\Visitor\Collection
This collection class is used to retrieve and manage multiple visitor records from the database in Magento 2. Devel...
Options
This class provides customer name prefix and suffix configuration options (like Mr., Mrs., Jr., Sr.) for forms thro...
Registration
This class determines whether customer registration is allowed on the Magento store. Developers can use this model...
Renderer\Region
This class renders the region/state field in customer address forms throughout Magento 2. It intelligently displays...
ResourceModel\Address
This class manages database operations for customer address entities in Magento 2. Developers use this resource mod...
ResourceModel\AddressRepository
The AddressRepository class is the main entry point for managing customer addresses in Magento 2. Developers use th...
ResourceModel\Address\DeleteRelation
This class handles the cleanup of default billing and shipping address references when a customer address is delete...
ResourceModel\Address\Relation
This class manages the relationship between customer addresses and their parent customer entity, specifically handl...
ResourceModel\Attribute
This resource model manages database operations for customer attributes in Magento 2's EAV (Entity-Attribute-Value)...
ResourceModel\Customer
This class is the resource model for customer entities in Magento 2, responsible for database operations related to...
ResourceModel\CustomerRepository
This class provides CRUD (Create, Read, Update, Delete) operations for customer entities in Magento 2. Developers u...
ResourceModel\Customer\Grid
This deprecated class manages the synchronization of the customer grid in Magento 2's admin panel. It identifies cu...
ResourceModel\Customer\Relation
This class handles the relationship between Customer entities and their associated Address records during save oper...
ResourceModel\Form\Attribute
This resource model manages the database operations for customer form attributes in Magento 2. It handles the stora...
ResourceModel\Group
This resource model handles database operations for customer groups in Magento 2. Developers use this class when th...
ResourceModel\GroupExcludedWebsite
This resource model manages database operations for customer group exclusions from specific websites in Magento's m...
ResourceModel\GroupExcludedWebsiteRepository
This repository class manages the relationship between customer groups and websites that should be excluded from th...
ResourceModel\GroupRepository
This class manages CRUD (Create, Read, Update, Delete) operations for customer groups in Magento 2. Developers use...
ResourceModel\Group\GetCustomerGroupCodesByIds
This class retrieves customer group codes based on provided customer group IDs. Developers use it when they need to...
ResourceModel\Group\Resolver
This class retrieves a customer's group ID directly from the database using their customer ID. Developers use this...
ResourceModel\Visitor
This resource model manages database operations for the customer_visitor table in Magento 2, which tracks visitor s...
Session
This class manages the customer session in Magento 2, handling customer login/logout operations, storing customer d...
Session\CurrentCustomer
This helper class provides a unified way to access the current customer's data in Magento 2, with special handling...
Session\CurrentCustomerAddress
This helper class provides convenient access to the default billing and shipping addresses for the currently logged...
Session\SessionCleaner
This class is responsible for clearing all session data associated with a specific customer, effectively logging th...
Session\Storage
This class manages storage for customer session data in Magento 2. It extends the framework's base storage class an...
Session\Validators\CutoffValidator
This validator ensures customer sessions remain valid by checking if a session was created before a cutoff timestam...
SetCustomerStore
This class sets the current store context for a customer based on their website or store ID. Developers would use t...
StoreSwitcher\RedirectDataPostprocessor
This class handles customer authentication when switching between different store views in a multi-store Magento se...
StoreSwitcher\RedirectDataPreprocessor
This class prepares customer data when a logged-in user switches between different store views in a Magento multi-s...
Url
This class generates URLs for all customer-related pages in Magento 2, such as login, registration, account dashboa...
Validator\Address\File
This class validates file uploads for customer addresses to prevent security vulnerabilities like path traversal at...
Validator\City
This validator ensures that customer city names contain only valid characters (letters, diacritics, apostrophes, hy...
Validator\Dob
This validator ensures that a customer's date of birth is not set to a future date. Developers use this class durin...
Validator\Name
This validator class validates customer name fields (first name, last name, and middle name) against a specific pat...
Validator\Street
This validator class ensures that customer street address fields contain only allowed characters like letters, numb...
Validator\Telephone
This validator class ensures that customer telephone numbers contain only valid characters (digits, spaces, plus si...
Vat
This class handles VAT (Value Added Tax) number validation for EU customers in Magento 2. Developers use it to vali...
View
This helper class is responsible for generating a customer's full display name by concatenating their name componen...
Visitor
The Visitor model tracks and manages visitor sessions in Magento 2, storing information about both guest visitors a...
Webapi\ParamOverriderCustomerGroupId
This class automatically replaces placeholder values like '%customer_group_id%' in Web API requests with the actual...
Webapi\ParamOverriderCustomerStoreId
This class automatically replaces the placeholder '%customer_store_id%' with the actual store ID of the currently a...
Webapi\ParamOverriderCustomerWebsiteId
This class automatically replaces the placeholder '%customer_website_id%' with the actual website ID of the current...