PhpStorm
 
2023.2
Shortcuts: Windows
Get PhpStorm
You are viewing the documentation for an earlier version of PhpStorm.
  1. PHP frameworks and external tools
  2. WordPress
  3. WordPress-specific coding assistance

WordPress-specific coding assistance

Last modified: 05 September 2023

PhpStorm provides full coding assistance for developing WordPress including WordPress-aware code completion, search for hook registration functions and functions specified as hook registration parameters, navigation between hook registrations and the hook invocations, callbacks, the possibility to configure the coding style in accordance with the WordPress code style, viewing the official WordPress documentation from the PhpStorm editor, and so on.

Adding WordPress to a project 

To take advantage of coding assistance provided by PhpStorm, the WordPress installation you are working with should be configured in the project as an external library. As a result, the WordPress core file will be involved in indexing, which is the basis for resolving references and providing code completion, navigation, search, and so on.

If the wp-content folder is outside the WordPress installation, it needs to be added either as an include path or as a content root.

Configure the WordPress installation as a project include path

To add WordPress to your project as an external library, you need to add it to the list of include paths. Learn more in Configure include paths.

  1. In the Settings dialog (CtrlAlt0S), navigate to PHP.

  2. On the PHP page that opens, add the path to the WordPress installation folder to the Include Paths list: click the the Add button button and specify the path to the installation folder in the dialog that opens.

Add the wp-content folder to the project

If the wp-content folder is located outside the WordPress installation, you need to add it to the project individually, apart from the WordPress core files. This can be done in two ways:

  • To have the wp-content folder involved in indexing without putting it under the project version control, add it to the list of include paths:

    1. In the Settings dialog (CtrlAlt0S), navigate to PHP.

    2. On the PHP page that opens, add the path to the wp-content folder to the Include Paths list: click the the Add button button and specify the path to the folder in the dialog that opens.

  • To have the wp-content folder involved in indexing and put it under the project version control, add it as a content root:

    1. In the Settings dialog (CtrlAlt0S), navigate to Directories.

    2. On the Directories page that opens, click the Add Content Root button the Add button.

    3. In the dialog that opens, locate the wp-content directory and click OK.

    Learn more about configuring content roots in Configuring content roots. For more information about adding files and folders to version control, refer to Enable version control.

Configuring WordPress code style

In PhpStorm, you can use the WordPress Code Style in accordance with the WordPress coding standards. Learn more in Code style schemes.

Checking code against the WordPress coding standards

With PhpStorm, you can use the PHP_CodeSniffer tool, which detects coding standard issues, in combination with WordPress Coding Standards, which provides a set of WordPress-specific standards to PHP_CodeSniffer. This will ensure that your code is clean, consistent, and free of some common errors.

To get started, install PHP_CodeSniffer using any technique described in Install and configure PHP_CodeSniffer. Probably the easiest way is to install it with Composer.

Install PHP_CodeSniffer

  1. Inside composer.json, add the squizlabs/php_codesniffer dependency record to the require or require-dev key. Press CtrlSpace 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 AltEnter and select whether you want to install a specific dependency or all dependencies at once.

Next, install WordPress Coding Standards, which will provide WordPress-specific standards to PHP_CodeSniffer.

Install WordPress Coding Standards

  1. Inside composer.json, add the wp-coding-standards/wpcs dependency record to the require or require-dev key. Press CtrlSpace 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 AltEnter and select whether you want to install a specific dependency or all dependencies at once.

The WordPress Coding Standards package will be installed, and the corresponding WordPress 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 (CtrlAlt0S). For more information, refer to Enable PHP_CodeSniffer as a PhpStorm inspection.

Hooks support

PhpStorm indexes all hooks declared in the WordPress core and in the included plugins. This makes the basis for coding assistance when working with hooks.

Completion for parameters of the Action and Filter functions

Hook names are available in code completion of standard parameters for action and filter functions add_action() and add_filter().

Invoke completion for a parameter

  1. Start typing the declaration of an add_action() or add_filter() function.

  2. Press CtrlSpace and choose the relevant parameter from the list.

    ps_wp_hooks_completion.png

You can navigate from a hook registration (add_action() or add_filter() function) to the hook invocation.

Callbacks from a hook registration

You can navigate to the declaration of the function or method specified as the second parameter of a hook registration (add_action() or add_filter() function).

Learn more about search and navigation in Find and replace text in a file and Source code navigation.

Search for a hook invocation and navigate to it

Do one of the following:

  • Use the Navigate to Symbol functionality:

    1. Choose Navigate | Symbol from the main menu.

    2. In the Enter symbol name popup that appears, start typing the hook name in the search field. If necessary, select the Include non-project items checkbox. The contents of the list below the search field change as you type.

      Navigating to symbol

    3. Click the relevant hook from the list. PhpStorm opens the file where it is invoked and places the caret at the invocation.

  • Use the Search Everywhere functionality:

    1. Press Shift twice.

    2. Start typing the hook name in the search field. If necessary, select the Include non-project items checkbox. The contents of the list below the search field change as you type.

    3. Click the relevant hook from the list. PhpStorm opens the file where it is invoked and places the caret at the invocation.

Searching for hook registration functions

You can search for occurrences of a hook registration function and for occurrences of a function or method specified as the second parameter of a hook registration.

Learn more in Search for usages

List usages for a hook registration function

  1. Place the caret at the name of the desired hook registration function and press AltF7 or choose Edit | Find | Find Usages from the main menu.

  2. From the popup list that shows the available options in terms of hook/function name, choose the relevant option. The Find tool window opens with a new tab showing all the detected occurrences of the selected function.

  3. Explore the listed occurrences. To navigate to the relevant one, click it. PhpStorm opens the file with the selected function or method and places the caret at it.

List occurrences of a function or method specified as the second parameter of a hook registration

  1. Place the caret at the parameter of interest and press AltF7 or choose Edit | Find | Find Usages from the main menu. The Find tool window opens with a new tab showing all the detected occurrences of the function or method specified as the parameter on which the search was invoked.

  2. Explore the listed occurrences. To navigate to the relevant one, click it. PhpStorm opens the file with the selected function or method and places the caret at it.

Viewing the official WordPress documentation from PhpStorm

You can view the official WordPress Documentation at http://wordpress.org/ right from the PhpStorm editor.

See also

Procedures

Reference