PhpStorm Plugin Development
Introduction
PhpStorm is an IntelliJ Platform-based product. Plugins for PhpStorm are developed in Java using the Ultimate edition of IntelliJ IDEA. The PsiViewer plugin is also recommended.
This page describes configuring plugin projects targeting PhpStorm. See also:
Configuring Plugin Projects Targeting PhpStorm
The IntelliJ IDEA Ultimate Edition (with the PHP plugin) must be used for developing PhpStorm plugins because the PHP plugin is incompatible with IntelliJ IDEA Community Edition. However, this IntelliJ IDEA Ultimate configuration runs the risk of accidentally using some APIs that are not available in PhpStorm. The recommended best practice is to use PhpStorm for testing.
Configuration of a Gradle-based PhpStorm plugin project is used as a tutorial in the section Configuring Plugin Projects using the IntelliJ IDEA Product Attribute. Many techniques are discussed, such as choosing a version of IntelliJ IDEA Ultimate given a targeted version of PhpStorm. The table below summarizes the gradle-intellij-plugin attributes to set in the build.gradle file for a PhpStorm plugin project:
The table below summarizes the gradle-intellij-plugin attributes to set in the plugin project's build.gradle file. Click on an entry in the table's Attribute column to go to the documentation about that attribute. To see how these attributes appear in the build.gradle file for PhpStorm, see Configuring build.gradle using the IntelliJ IDEA Product Attribute.
gradle-intellij-plugin Attribute | Attribute Value |
|---|---|
intellij.type | IU for IntelliJ IDEA Ultimate. The required PHP plugin isn't compatible with IntelliJ IDEA Community Edition. |
intellij.version | Set to the same IU BRANCH.BUILD as the PhpStorm target version, e.g. 193.5233.102. |
intellij.plugins | com.jetbrains.php:193.5233.102 for the PHP plugin. See below for PHP plugin version information. |
runIde.ideDirectory | Path to locally installed target version of PhpStorm. For example, on macOS: /Users/<user name>/Library/Application Support/JetBrains/Toolbox/apps/PhpStorm/ch-0/193.5233.101/PhpStorm.app/Contents. |
The PHP plugin version is explicitly declared because it isn't bundled with IntelliJ IDEA Ultimate Edition. Select a version of the PHP plugin compatible with the intellij.version.
The dependency on the PHP plugin APIs must be declared in the plugin.xml file, as shown in the tutorial Configuring plugin.xml section.