Drupal

Option 1: Use the Event log

• In the Event Log tool window, click Fix next to the Drupal support: <*.file extension> files are not associated with PHP file type message.

Option 2: Use the File Types page

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

  On the File Types page that opens, define file masks in the File Name Patterns area. See File type associations for details.

• 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

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

Use the pre-configured Drupal code style in a project

• In the Event Log tool window, click Set next to the Drupal-style formatting can be set for this project message.

Install PHP_CodeSniffer

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

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 section. Press Ctrl+Space to get code completion for the package name and version.

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). See Enable PHP_CodeSniffer as a PhpStorm inspection for details.

Configure Drush automatically

• On project opening, PhpStorm will detect and configure Drush and display the notification in the Composer Log.

  

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

  note

  On Windows, automatic Drush detection requires a configured local PHP interpreter.

Configure Drush manually

1. In the Settings dialog (Ctrl+Alt+S), go to Tools | 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 Command Line Tool Support page. Optionally, click to edit the tool properties, or to customize the commands set. See Customize a tool for details.

Run Drush commands

• From the main menu, choose 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.

  

  Gif

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, select 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.

   

   Gif

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 details, see Install plugins.

   note

   The Drupal Symfony Bridge plugin depends on the Symfony Support plugin, which will be installed automatically.

2. Enable annotations

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