module-file-structure.md

layout	group	subgroup	title	menu_title	menu_order	version	github_link	redirect_from
default	extension-dev-guide	03_Build	Create your component file structure	Create your component file structure	3000	2.0	extension-dev-guide/build/module-file-structure.md	/guides/v2.0/extension-dev-guide/module-file-structure.html

In this section, we go over the different file structures for the component types. The Magento application looks for the files that make up a component including configuration files in particular places inside the component file structure. Follow the predefined file structures for the component type you are developing to ensure that it works as expected.

{% include php-dev/component-root.md %}

Module file structure

A typical file structure for a Magento 2 module can look like the following:

{:width="300px"}

Common directories

{:.no_toc} Following are some common module directories:

• Block: contains PHP view classes as part of Model View Controller(MVC) vertical implementation of module logic.
• Controller: contains PHP controller classes as part of MVC vertical implementation of module logic.
• etc: contains configuration files; in particular, module.xml, which is required.
• Model: contains PHP model classes as part of MVC vertical implementation of module logic.
• Setup: contains classes for module database structure and data setup which are invoked when installing or upgrading.

Additional directories

{:.no_toc} Additional folders can be added for configuration and other ancillary functions for items like plugin-ins, localization, and layout files.

• Api: contains any PHP classes exposed to the API.
• i18n: contains localization files.
• Plugin: contains any needed plug-ins.
• view: contains view files, including static view files, design templates, email templates, and layout files.

Theme file structure

A typical theme file structure can look like the following:

├── composer.json
├── etc
│   └── view.xml
├── i18n
│   └── en_US.csv
├── LICENSE_AFL.txt
├── LICENSE.txt
├── media
│   └── preview.jpg
├── registration.php
└── web
    ├── css
    │   ├── email.less
    │   ├── print.less
    │   ├── source
    │   │   ├── _actions-toolbar.less
    │   │   ├── _breadcrumbs.less
    │   │   ├── _buttons.less
    │   │   ├── components
    │   │   │   └── _modals_extend.less
    │   │   ├── _icons.less
    │   │   ├── _layout.less
    │   │   ├── _theme.less
    │   │   ├── _tooltips.less
    │   │   ├── _typography.less
    │   │   └── _variables.less
    │   ├── _styles.less
    │   ├── styles-l.less
    │   └── styles-m.less
    ├── images
    │   └── logo.svg
    └── js
        ├── navigation-menu.js
        ├── responsive.js
        └── theme.js

Common directories

{:.no_toc} Typical theme directories are:

• etc: Contains configuration files such as the view.xml file which contains image configurations for all images and thumbnails.

• i18n: Translation dictionaries, if any.

• media: Theme preview images (screen capture of your theme) can be put in here.

• web: Optional directory that contains static files organized into the following subdirectories:

  • css/source: Contains a theme's less configuration files that invoke mixins for global elements from the Magento UI library, and the theme.less file that overrides the default variables values.
  • css/source/lib: Contains view files that override the UI library files stored in lib/web/css/source/lib.
  • fonts: The folder to place the different fonts for your theme.
  • images: Static images folder.
  • js: The folder for your JavaScript files.

For more details on the theme folder structure, see Magento theme structure.

{% include php-dev/lang-pack-file-struct.md %}

Next

Register your component