Drupal

Option 1: Enable Drupal support in PhpStorm settings

1. Open Settings (Ctrl+Alt+S) | PHP | Frameworks.

2. Extend the Drupal node, select the Enable Drupal integration checkbox, and specify the parameters as follows:

   

   Drupal installation path	Specify the path to the root directory that contains the installed Drupal core.
   Set up PHP | Include paths	Select the Set up PHP | Include paths checkbox to have PhpStorm automatically add Drupal core directories to the project's include paths. To configure the paths manually, open Settings (Ctrl+Alt+S) | PHP and edit the list of direectories on the Include path tab.
   Version	Choose the version of Drupal to use, the supported versions are 6, 7, 8, and 9.

3. Click Apply to save the changes.

Option 2: Create a new PhpStorm project from a Drupal template

You can create a new Drupal project in PhpStorm from a Drupal Module template.

PhpStorm generates and configures a project stub in accordance with the selected Drupal version. For Drupal 8, a module_name.info.yml file is generated.

1. Open the New Project dialog by choosing File | New Project in the main menu or clicking Create New Project on the PhpStorm Welcome screen.

2. In the left-hand pane, select Drupal Module.

3. In the right-hand pane, specify the Drupal support parameters.

Option 3: Import an existing Drupal module project

When you open (File | Open in the main menu) an existing Drupal module project in PhpStorm, the IDE recognizes the Drupal-specific project structure and suggests activating Drupal support.

Click Enable Drupal Support to open the modal dialog and specify the parameters.

Associate file types manually

1. In the Settings dialog (Ctrl+Alt+S) , navigate to Editor | File Types.

2. On the File Types page that opens, select PHP on the Recognized File Types list.

3. In the File name patterns area to the right, click () and add one by one the *.test, *.install, *.engine, *.profile, and *.theme file name patterns.

   

   For more information, refer to File type associations.

• Use code completion for hook 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.

  

• Navigate to hook invocations.

  • 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, and you can choose the one to jump to.

    

    You will be navigated to the line where the relevant hook is invoked with module_invoke_all(), module_invoke(), or drupal_alter().

• View hook documentation.

  Place the caret at the name of the hook and choose View | Quick Documentation Lookup or press Ctrl+Q.

  

Change code style settings manually

You can also set the predefined code style manually on the Code Style: PHP page.

1. In the Settings dialog (Ctrl+Alt+S) , navigate to Editor | Code Style | PHP.

2. Click Set from and choose Drupal from the drop-down list that opens.

3. If applicable, customize the code style using the controls on the page.

Install PHP_CodeSniffer

1. Inside composer.json, add the squizlabs/php_codesniffer dependency record to the require or require-dev key. To get code completion for the package name and version, press Ctrl+Space.

2. Do one of the following:

   • Click the Install shortcut link on top of the editor panel.

   • If the Non-installed Composer packages inspection is enabled, PhpStorm will highlight the declared dependencies that are not currently installed. Press Alt+Enter and select whether you want to install a specific dependency or all dependencies at once.

Install Coder

1. Inside composer.json, add the drupal/coder dependency record to the require or require-dev key. To get code completion for the package name and version, press Ctrl+Space.

2. Do one of the following:

   • Click the Install shortcut link on top of the editor panel.

   • If the Non-installed Composer packages inspection is enabled, PhpStorm will highlight the declared dependencies that are not currently installed. Press Alt+Enter and select whether you want to install a specific dependency or all dependencies at once.

The Coder package will be installed, and the corresponding Drupal standard will be selected for the PHP_CodeSniffer validation inspection automatically. If necessary, you can further customize the inspection on the Editor | Inspections page of the Settings dialog (Ctrl+Alt+S) . For more information, refer to Enable PHP_CodeSniffer as a PhpStorm inspection.

Configure Drush automatically

• When you install Composer dependencies in a Drupal project, PhpStorm detects and configures Drush automatically and displays a respective notification in the Composer Log.

  

  If you want to customize the tool, click in the gutter to quickly jump to the PHP Command Line Tool Support settings page.

Configure Drush manually

1. In the Settings dialog (Ctrl+Alt+S) , go to Tools | PHP Command Line Tool Support.

2. Click on the toolbar.

3. In the Command Line Tools dialog, choose Drush from the list, and specify its visibility level (Project or Global).

   

4. When you click OK, the Drush dialog opens.

   Specify the path to the Drush executable. The default location is commonly C:/ProgramData/Drush/drush.bat on Windows and /usr/bin/drush on macOS or Linux. If you followed the standard installation procedure, click OK to accept the predefined path.

   In case of custom installation, type the path to the Drush executable file and click OK.

5. Click OK to apply changes and return to the PHP Command Line Tool Support page. Optionally, click to edit the tool properties, or to customize the commands set. For more information, refer to Customize a tool.

Run Drush commands

• Go to Tools | Run Command or press Ctrl twice.

  In the Run Anything window that opens, type the call of the command in the <drush> <command> format.

  The command execution result is displayed in the Run tool window.

  

Terminate a command

• Click on the Run tool window toolbar.

Debug Drush commands

Drupal commands are defined in controller classes that extend DrushCommands. To debug a command, it is crucial that you initiate a debugging session for the command itself, and not the controller class file it is defined in. Otherwise, the Drupal bootstrapping process will be skipped, and the execution will fail.

1. In the controller class corresponding to the selected command, click the editor gutter at a code line where you want to set a breakpoint.

   

2. Create a run/debug configuration that will run the drush tool with the selected command. In the main menu, go to Run | Edit Configurations, then click and choose PHP Script from the list.

   

3. In the PHP Script dialog, provide the run/debug configuration parameters.

   • In the File field, provide the path to the drush executable file.

   • In the Arguments field, type the actual command and its arguments, such as status.

   

4. On the PhpStorm toolbar, select the created run/debug configuration and click . The command execution will stop at the specified breakpoint.

   

1. Install the Drupal Symfony Bridge plugin

   In the Settings dialog (Ctrl+Alt+S) , navigate to the Plugins page. Click Browse Repositories, select the plugins and click Install. For more information, refer to Install plugins.

2. Enable annotations

   To get advanced annotations support, install the PHP Annotations plugin as described in Install plugins.