https://github.com/magento/magento2-phpstorm-plugin
PHPStorm Plugin for Magento 2
https://github.com/magento/magento2-phpstorm-plugin
hacktoberfest intellij intellij-plugin java javascript jetbrains magento magento2 php phpstorm phpstorm-plugin requirejs
Last synced: 18 days ago
JSON representation
PHPStorm Plugin for Magento 2
- Host: GitHub
- URL: https://github.com/magento/magento2-phpstorm-plugin
- Owner: magento
- License: osl-3.0
- Created: 2017-12-05T17:00:54.000Z (over 8 years ago)
- Default Branch: 5.4.0-develop
- Last Pushed: 2026-03-26T11:13:07.000Z (27 days ago)
- Last Synced: 2026-04-02T09:30:19.118Z (21 days ago)
- Topics: hacktoberfest, intellij, intellij-plugin, java, javascript, jetbrains, magento, magento2, php, phpstorm, phpstorm-plugin, requirejs
- Language: Java
- Homepage:
- Size: 20 MB
- Stars: 456
- Watchers: 361
- Forks: 100
- Open Issues: 124
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: COPYING.txt
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-magento2 - PhpStorm Magento2 Extension - Official PhpStorm Magento2 (Tools / Meet Magento)
README
# PhpStorm Magento 2 Plugin
PhpStorm IDE Plugin for a better Magento 2 development workflow.
Support the Project
If you find this plugin helpful and want to support its development, consider buying the contributors a coffee:
Thank you to our sponsors—your support means everything:
Lucas van Staden
Ivan Chepurnyi
Michael Ryvlin
## Features
* Configuration smart completion and references for XML/JavaScript files
* `Navigate to configuration` reference in scope of class/interface
* `Go to plugin` reference in scope of class/interface and method
* `Navigate to Web API configuration` reference in scope of class/interface and method
* Plugin class methods generation
* Plugin declaration inspection
* RequireJS reference navigation and completion
* MFTF reference navigation and completion
* GraphQL navigation line markers
* Code generation
* Inspections for XML configuration
[](https://plugins.jetbrains.com/plugin/8024)
[](https://plugins.jetbrains.com/plugin/8024)
[](https://magento.com)
## Installation
1. Go to `Settings > Preferences` in the PhpStorm IDE
2. Navigate to `Plugins`
3. Click the `Browse repositories...` button and search for "Magento PhpStorm"
4. Install the plugin and restart PhpStorm
5. Go to `Settings > Preferences > Languages & Frameworks > PHP > Frameworks > Magento` in the PhpStorm IDE
6. Check `Enable` and click the `OK` button
## Works with
* PhpStorm 2026+
## Setting up development environment
1. Check out this repository.
1. Open the project in IntelliJ IDEA.
1. Make sure that you are on the latest develop branch (for example `5.4.0-develop`).
1. Import the Gradle project from `build.gradle.kts`.
1. Use **JDK 21** for both the project SDK and the Gradle JVM:
- `Right click on the project root > Open Module Settings > Project > Project SDK`
- `IntelliJ IDEA > Preferences > Build, Execution, Deployment > Build Tools > Gradle > Gradle JVM`
1. In the Gradle tool window, run `Tasks > Intellij platform > runIde`.
1. The task launches a PhpStorm sandbox with the plugin installed. Make sure the plugin is enabled and indexing is finished before testing features.
## How to contribute
1) Start with looking into [Community Backlog](https://github.com/magento/magento2-phpstorm-plugin/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22). Any ticket in `Ready for Development` and `Good First Issue` columns are a good candidates to start.
2) Didn't satisfy your requirements? [Create a new issue](https://github.com/magento/magento2-phpstorm-plugin/issues/new). It can be for example:
- **Bug report** - Found a bug in the code? Let us know!
- **Enhancement** - Know how to improve existing functionality? Open an issue describe how to enhance the plugin.
- **New feature proposal** - Know how to make a killer feature? Do not hesitate to submit your proposal.
3) The issue will appear in the `Ready for Grooming` column of the [Community Backlog](https://github.com/magento/magento2-phpstorm-plugin/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22). Once it will be discussed and approved the issue will be ready for development.
4) Refer to the [Contributing Guide](https://github.com/magento/magento2-phpstorm-plugin/blob/5.4.0-develop/.github/CONTRIBUTING.md) for more information on how to contribute.
## Learn to contribute
1) SDK [Developing a Plugin](https://plugins.jetbrains.com/docs/intellij/developing-plugins.html)
2) Good Presentation about platform [How We Built Comma, the Raku IDE, on the IntelliJ Platform](https://www.youtube.com/watch?v=zDP9uUMYrvs)
3) Plugin example [idea-php-symfony2-plugin](https://github.com/Haehnchen/idea-php-symfony2-plugin)
## How to create SandBox for development
1. Create sandbox folder
2. Copy to sandbox folder `composer.json` and `composer.lock`
3. In sandbox folder create `app/code` and `vendor/magento`
4. Copy any of the magento modules (as for example: `framework`, `module-catalog`, `module-checkout`, `module-customer`, `module-sales`) into the `vendor/magento` folder. It is better to add as few modules as possible to reduce reindexing time during application running
5. (Nice to have) Open IDE and go to `Preferences > Editor > File and Code Templates > Includes tab` and add default headers for `PHP File Header` and `XML File Header`
**PHP File Header:**
```php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
```
**XML File Header:**
```xml
```
### 
Join the [#phpstorm-plugin](https://magentocommeng.slack.com/archives/C010C2LUCEA) Slack channel to get more involved
## License
Each Magento source file included in this distribution is licensed under OSL-3.0 license.
Please read the [LICENSE.txt](https://github.com/magento/magento2-phpstorm-plugin/blob/5.4.0-develop/LICENSE.txt) for the full text of the [Open Software License v. 3.0 (OSL-3.0)](http://opensource.org/licenses/osl-3.0.php).