Module naming and location conventions

Overview

When developing or working with modules, be aware of Magento standards and conventions, such as naming conventions and the location of modules within the file system.

Be sure to research additional Magento conventions, beyond those applicable to modules. For more information, see Coding Standards.

Module location conventions

The following table shows the standard locating within the Magento file system for specific entities.

Module naming convention

Several modules in Magento have composite names. For example, when a name consists of several words with capitalized first letters. Because a module alias is in lowercase, there is no simple solution to convert module alias to module name. To solve this issue setup class contains correspondence array of modules with composite names and this array is used in class name generation.

Example: catalogsearch is the module alias of the Magento_CatalogSearch module.

Related topics

• Module dependencies
• Module relationships
• Modules and areas