Log in

Cms Module

Api\BlockRepositoryInterface

Repository

This repository interface defines the contract for managing CMS blocks in Magento 2. Developers use this to programmatically create, read, update, and...

Api\Data\BlockInterface

Interface

This interface defines the contract for CMS Block data objects in Magento 2. Developers use this when working with CMS blocks programmatically to get...

Api\Data\BlockSearchResultsInterface

Interface

This interface defines the contract for search results when querying CMS blocks through the API. Developers use this when implementing or consuming re...

Api\Data\PageInterface

Interface

This interface defines the contract for CMS page data objects in Magento 2. Developers use it to interact with CMS page properties like title, content...

Api\Data\PageSearchResultsInterface

Interface

This interface defines the contract for CMS page search results in Magento 2. Developers use this when implementing or consuming repository methods th...

Api\GetBlockByIdentifierInterface

Interface

This interface defines a command to retrieve CMS block data by its identifier and store ID. Developers use this when they need to programmatically fet...

Api\GetPageByIdentifierInterface

Interface

This interface defines a service contract for retrieving CMS page data by its URL identifier and store ID. Developers use this when they need to progr...

Api\GetUtilityPageIdentifiersInterface

Interface

This interface defines a contract for retrieving identifiers of utility CMS pages in Magento 2. Developers would use implementations of this interface...

Api\PageRepositoryInterface

Repository

This interface defines the contract for managing CMS pages in Magento 2. Developers use this repository to create, read, update, and delete CMS pages...

Block

Model

This is the core model class for CMS Static Blocks in Magento 2. Developers use this class to programmatically create, retrieve, update, or delete sta...

BlockRepository

Model

This repository class provides standardized methods for managing CMS blocks in Magento 2. Developers use it to save, retrieve, search, and delete CMS...

BlockSearchResults

Model

This class serves as a container for CMS block search results returned by repository search operations. Developers use this when implementing or consu...

Config\Source\Block

Model

This class provides a source of CMS block options for use in system configuration fields and admin forms. Developers use this class when they need to...

Config\Source\Page

Model

This class provides a list of CMS pages as options for use in admin configuration dropdowns and form selects. Developers use this class when they need...

GetBlockByIdentifier

Model

This class retrieves a CMS block by its identifier for a specific store. Developers use this when they need to programmatically fetch a CMS block by i...

GetPageByIdentifier

Model

This class retrieves a CMS page by its unique identifier (URL key) for a specific store. Developers use this when they need to programmatically load a...

GetUtilityPageIdentifiers

Model

This class retrieves the identifiers of special utility CMS pages configured in Magento's store settings. Developers use this to programmatically acce...

Model\PageRepository\ValidatorInterface

Interface

This interface defines a contract for validating CMS pages before they are saved to the repository. Developers implement this interface to create cust...

Model\Page\CustomLayoutManagerInterface

Interface

This interface defines contracts for managing custom layout XML files for CMS pages in Magento 2. Developers use it to retrieve available custom layou...

Model\Page\CustomLayoutRepositoryInterface

Repository

This repository interface manages custom layout file selections for CMS pages in Magento 2. Developers use it to programmatically assign, retrieve, or...

Model\Page\TargetUrlBuilderInterface

Interface

This interface defines a contract for building target URLs for CMS pages based on a route path and store code. Developers would implement this interfa...

Model\ResourceModel\AbstractCollection

Collection

This is an abstract base collection class for CMS pages and blocks in Magento 2. Developers extend this class when creating custom collections for CMS...

Model\ResourceModel\Page\Collection

Collection

This collection class is used to retrieve and manage multiple CMS pages from the database. Developers use it to load, filter, and manipulate sets of C...

Model\Wysiwyg\ConfigProviderFactory

Factory

This factory class creates instances of WYSIWYG (What You See Is What You Get) configuration provider objects. Developers use this when they need to i...

Page

Model

The CMS Page Model represents a content page in Magento 2's Content Management System. Developers use this class to create, retrieve, update, and mana...

Page

Helper

This helper class manages the preparation and rendering of CMS pages in Magento 2. Developers use it to configure page layouts, apply custom themes, h...

PageRepository

Model

PageRepository provides CRUD operations for managing CMS pages in Magento 2. Developers use this class to programmatically create, retrieve, update, a...

PageRepository\ValidationComposite

Model

This class acts as a decorator/wrapper around the CMS Page Repository that adds validation capabilities before saving pages. Developers use this to en...

PageRepository\Validator\LayoutUpdateValidator

Model

This validator ensures CMS page data is valid before saving to the repository. It checks that required fields like title are populated and validates a...

PageSearchResults

Model

This class is a Data Transfer Object (DTO) that holds search results for CMS pages. Developers use this when implementing repository methods that retu...

Page\Authorization

Model

This class handles authorization checks when saving CMS pages, specifically ensuring users have proper permissions to modify design-related fields lik...

Page\CustomLayout\CustomLayoutManager

Model

This class manages custom layout files for CMS pages in Magento 2. Developers use it to discover available custom layout XML files for a specific page...

Page\CustomLayout\CustomLayoutRepository

Model

This repository manages custom layout file assignments for CMS pages in Magento 2. Developers use it to save, retrieve, validate, and delete custom la...

Page\CustomLayout\CustomLayoutValidator

Model

This validator ensures that custom layout XML updates for CMS pages cannot be modified after creation - they can only be removed. Developers would use...

Page\DataProvider

Model

This DataProvider class supplies data to the CMS Page admin form in Magento 2's UI component system. Developers use this class to populate the page ed...

Page\DomValidationState

Model

This class enforces DOM/XML validation for CMS page layout updates. It implements the ValidationStateInterface to always require validation when proce...

Page\IdentityMap

Model

This class acts as an in-memory cache (identity map pattern) for CMS Page objects during a single request. Developers use it to avoid loading the same...

Page\LayoutCacheTagResolver

Model

This class resolves cache tags for CMS page layouts to ensure proper cache invalidation when a page's layout changes. When an existing CMS page's layo...

Page\Source\CustomLayout

Model

This class provides a dropdown list of available custom layout options for CMS pages in the Magento admin panel. It extends PageLayout and adds a 'Def...

Page\Source\IsActive

Model

This class provides a data source for CMS page status options (enabled/disabled) used in admin forms and grids. Developers use it when building UI com...

Page\Source\IsActiveFilter

Model

This class provides filter options for CMS page active status in admin grids and forms. It extends the IsActive source model by adding an empty option...

Page\Source\PageLayout

Model

This class provides a list of available page layout options for CMS pages in Magento 2, formatted as an array suitable for dropdown menus and form fie...

Page\Source\PageLayoutFilter

Model

This class provides a filterable list of page layout options for CMS pages, extending the base PageLayout source model by adding an empty option at th...

Page\Source\Theme

Model

This class provides a dropdown list of available themes for CMS pages in Magento 2 admin panel. Developers use it when they need to populate theme sel...

Page\TargetUrlBuilder

Model

This class builds target URLs for CMS pages with proper store context. Developers use it when they need to generate frontend URLs for CMS pages that i...

ResourceModel\Block

Model

This resource model handles database operations for CMS blocks in Magento 2. Developers use it to load, save, and delete CMS blocks, check if block id...

ResourceModel\Page

Model

This resource model manages database operations for CMS pages in Magento 2. Developers use it to load, save, delete CMS pages, validate page URL keys,...

Template\Filter

Model

This filter class processes media directives in CMS content, converting media tags into actual file paths. Developers use this when rendering CMS page...

Template\FilterProvider

Model

This class provides template filter instances for CMS pages and blocks in Magento 2. Developers use it to retrieve filter objects that process templat...

WysiwygDefaultConfig

Model

This class provides a default, no-op implementation of the WYSIWYG editor configuration provider interface. It simply returns the configuration object...

Wysiwyg\CompositeConfigProvider

Model

This class manages configuration for different WYSIWYG editor adapters in Magento 2's CMS. It dynamically loads the appropriate configuration processo...

Wysiwyg\Config

Model

This class provides configuration for the WYSIWYG (What You See Is What You Get) editor used in Magento's CMS. Developers use it to retrieve editor se...

Wysiwyg\DefaultConfigProvider

Model

This class provides the default configuration for the TinyMCE WYSIWYG editor used in Magento's CMS module. Developers would use or extend this class w...

Wysiwyg\Gallery\DefaultConfigProvider

Model

This class provides configuration for the WYSIWYG editor's image gallery/media browser in Magento 2's CMS module. Developers would use this when custo...

Wysiwyg\Images

Helper

This helper class manages WYSIWYG editor image operations in Magento 2's CMS module. Developers use it to handle image paths, URLs, and file storage o...

Wysiwyg\Images\GetInsertImageContent

Model

This class generates the appropriate content (URL or HTML) for inserting images into WYSIWYG editors in Magento's CMS. Developers use it when they nee...

Wysiwyg\Images\Storage

Model

This class manages the file storage for WYSIWYG editor images in Magento 2's CMS module. Developers use it to handle image uploads, create/delete dire...

Wysiwyg\Validator

Model

This class validates WYSIWYG HTML content in Magento 2's CMS module, ensuring it doesn't contain restricted or malicious elements. Developers use it w...