You can use PhpStorm as an IDE for Drupal development including modules, themes, and core. The supported versions are 6, 7, and 8.
In this part:
- Where do I get Drupal from?
- How do I set up a Drupal project in PhpStorm?
- How do I associate Drupal-specific files with the PHP file type?
- How do I use Drupal hooks in PhpStorm?
- How do I set up the Drupal code style in a PhpStorm project?
- How do I check my code against the Drupal coding standards?
- How do I view the Drupal API documentation from PhpStorm?
- How do I use the Drush command line tool from PhpStorm?
- How do I use Drupal 8 with Symfony2?
Where do I get Drupal from?
How do I set up a Drupal project in PhpStorm?
Option 1: Create a PhpStorm project with a Drupal module
You can create a PhpStorm project by a Drupal Module template, this project will be set up and configured in accordance with the Drupal requirements.
- Open the New Project dialog
Choose File | New Project or click Create New Project on the Welcome screen.
- Choose the project type and location
In the left-hand pane, click Drupal Module. In the Location field on the right-hand pane, specify the folder where the project will be created.
- Choose Drupal installation to use
Specify the root folder of the Drupal installation and choose the version of Drupal to use, the supported versions are 6, 7, and 8.
- Configure Include paths
Select the Set up PHP | Include paths check box to have Drupal include paths automatically configured for the project. After you leave the dialog box, the following paths will be added to the Include Paths list on the PHP page:
<drupal installation root>/includes,
<drupal installation root>/modules, and
<drupal installation root>/sites/all/modules
- Open your project
Click Open on the Welcome screen or choose File | Open on the main menu, then choose the folder where your Drupal module is stored. PhpStorm detects a Drupal-specific structure and shows a notification:
- Enable Drupal support
Click Enable in the notification. In the Drupal Module dialog box that opens, select the Enable Drupal integration check box and proceed as when creating a project with a Drupal module: specify the root folder of the Drupal installation, choose the version to use, and configure include paths.
Whether you enable the Drupal support in an existing PhpStorm project or create a new project with a Drupal module, PhpStorm checks if the development environment is configured properly for Drupal development.
How do I associate Drupal-specific files with the PHP file type?
PhpStorm recognizes and treats files as
php files and provides code highlighting based on file type associations.
Option 2: Use the File Types page
Open the File Types page (File | Settings | Editor | File Types for Windows and Linux or PhpStorm | Preferences | Editor | File Types for macOS) and define file masks in the Registered Patterns area. See Creating and Registering File Types for details.
How do I change the Drupal settings?
- Enable or disable Drupal integration
On the Frameworks page (File | Settings | Languages and Frameworks | PHP | Frameworks for Windows and Linux or PhpStorm | Preferences | Languages and Frameworks | PHP | Frameworks for macOS), toggle the Enable Drupal integration check box to activate or deactivate Drupal in the current PhpStorm project.
To use another Drupal installation, type the path to the relevant installation folder. Change the version if necessary.
- Update the include paths
On the PHP page (File | Settings | Languages and Frameworks | PHP for Windows and Linux or PhpStorm | Preferences | Languages and Frameworks | PHP for macOS), make the required changes in the Include Paths area.
How do I use Drupal hooks in PhpStorm?
PhpStorm provides full native support of Drupal hooks in
Step 1: Use code completion for hoo declarations
PhpStorm indexes any hook invocation whereupon hook names become available in code completion for creating hook implementations. To complete a declaration, start typing the hook name and press Ctrl+Space.
- To navigate to a hook invocation from the editor, click the icon in the gutter.
- In case of multiple invocations, PhpStorm displays a list of available hook invocations so you can choose which one to jump to. You will be navigated to the line where the relevant hook is invoked with
How do I set up the Drupal code style in a PhpStorm project?
PhpStorm automatically offers to apply the pre-configured Drupal Coding Standards (code style) if a project is recognized as a Drupal Module, or if the Drupal integration is enabled in an existing project, or when you create a new project with a Drupal Module. However, you can at any time change or customize this setting on the Code Style: PHP page of the Settings dialog box.
How do I check my code against the Drupal coding standards?
With PhpStorm, you can use two tools that detect violations against the Drupal coding standard: Coder and PHP Code Sniffer. They ensure your code remains clean and consistent and help prevent some common semantic errors made by developers.
- Install PHP Code Sniffer as a PEAR package or using Composer. For detailed installation instructions, see https://github.com/squizlabs/PHP_CodeSniffer.
- Register PHP Code Sniffer in PhpStorm and configure it as a PhpStorm inspection as described in PHP Code Sniffer.
- Download the Drupal Coder module (7x-2.0 version is recommended).
- Unpack the downloaded archive and find the
coder_sniffer/Drupalsubdirectory inside. This directory should contain the
ruleset.xmlfile and some other subdirectories.
- Move the contents of
<php installation folder>/CodeSniffer/Standards/Drupal.
How do I view the Drupal API documentation from PhpStorm?
In the PhpStorm editor, select the symbol you are interested in and choose Search in Drupal API on the context menu. The Drupal API Documentation opens.
How do I use the Drush command line tool from PhpStorm?
Step 1: Download and install Drush
Download and install Drush as described at https://github.com/drush-ops/drush.
- Open the Command Line Tool Support page
Choose File | Settings | Tools | Command Line Tool Support for Windows and Linux or PhpStorm | Preferences | Tools | Command Line Tool Support for macOS. The Command Line Tool Support page opens.
- Specify the tool type and visibility
Click Add and choose Drush in the Choose Tool to Add dialog. Choose whether Drush will be available in the current project (Project visibility or across all PhpStorm projects (Global visibility). When you click OK, the Drush dialog opens.
- Specify the Drush executable
In the Drush dialog that opens, PhpStorm has automatically filled in the default executable location, which is usually
C:/ProgramData/Drush/drush.baton Windows and
/usr/bin/drushon macOS or Linux. If you followed the standard installation procedure, the predefined path will be correct, just click OK.
In case of custom installation, type the path to the Drush executable file and click OK.
- Specify the alias for Drush
In the Alias text box, specify the alias to use in calls of tool commands. Accept the default alias or edit it, if necessary.
- Activate Drush
Select the Enable check box to activate the detected command set.
Step 3: Run Drush commands
Open the Input pane (Tools | Run Command) and type
drush by default) and press Ctrl+Space to invoke completion. The result of command execution is shown in the Output tab with the name of the command. Learn more from How do I run a command?.
How do I use Drupal 8 with Symfony2?
PhpStorm provides close integration between Drupal, version 8 and Symfony2 which connects Symfony2 components and Drupal infrastructure. To take advantage from this integration:
Step 1: Install the Drupal Symfony2 Bridge plugin
Open the Plugins page (File | Settings | Plugins for Windows and Linux or @product@ | Preferences | Plugins for macOS), click Browse Repositories, select the plugins and click Install. For details, see Installing, Updating and Uninstalling Repository Plugins and in Enabling and Disabling Plugins.
Step 2: Enable annotations
To get advanced annotations support, install the PHP Annotations plugin as described in Installing, Updating and Uninstalling Repository Plugins and in Enabling and Disabling Plugins.
- Completion for major Drupal-specific parameters in
<module_name>.info.ymlfiles that contain information about Drupal modules.
- Strings suitable for use inside Drupal-specific t() function are indexed across your project and offered for completion.
- Completion for relevant
.ymlkey values in url() and other Drupal API functions, which makes search for the right value easier.
- Navigation to the
.ymlfile by pressing Ctrl+B or choosing .
- Full support for service containers described in
.ymlfiles, including completion and navigation with Ctrl+B.
- Support of the Twig template engine, which is now the default template engine for Drupal 8, including completion, navigation, and recognition of Drupal functions. See also Twig in Drupal 8.