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

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.
2. Open the project in IntelliJ IDEA.
3. Make sure that you are on the latest develop branch (for example 5.4.0-develop).
4. Import the Gradle project from build.gradle.kts.
5. 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
6. In the Gradle tool window, run Tasks > Intellij platform > runIde.
7. 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. 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. 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. Once it will be discussed and approved the issue will be ready for development.
4. Refer to the Contributing Guide for more information on how to contribute.

Learn to contribute

1. SDK Developing a Plugin
2. Good Presentation about platform How We Built Comma, the Raku IDE, on the IntelliJ Platform
3. Plugin example 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:

/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

XML File Header:

<!--
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
-->

Join the #phpstorm-plugin 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 for the full text of the Open Software License v. 3.0 (OSL-3.0).