PhpStorm 2019.1 Help

Preparing to use WordPress

PhpStorm provides a dedicated interface for developing and running WordPress applications and provides WordPress-aware coding assistance, see WordPress Specific Coding Assistance. To get access to this functionality in a project, you need to download WordPress, register it in PhpStorm, and activated the WordPress integration within the current project.

Alternatively, you can download WordPress and create a stub of a WordPress-targeted project. In this case, the WordPress integration in the project will be activated automatically.

Whether you enable the WordPress integration in an existing project or create a stub of a WordPress application, PhpStorm checks if the development environment is configured properly for WordPress development. If the configuration does not meet the requirements, PhpStorm displays a popup with a Fix link.

Before you start

  1. Make sure the PHP interpreter is configured in PhpStorm on the PHP page, as described in Configuring Local PHP Interpreters and Configuring Remote PHP Interpreters.

  2. Make sure the PHP and WordPress Support plugins are installed and enabled.

    The plugins are activated by default. If the plugins are disabled, enable them on the Plugins page as described in Managing plugins.
  3. Configure the PHP interpreter to use WordPress with, as described Configuring Remote PHP Interpreters. Note that WordPress requires PHP 5.3 or higher.

Download and install WordPress

  1. Download the WordPress.zip archive at https://wordpress.org/download/.

  2. Extract the archive:

    • To have the possibility to run your WordPress application on a local Web server, store the extracted file to the document root of the server where the PHP interpreter is configured. For local development environment with the Apache HTTPD Web server, extract WordPress.zip to the htdocs folder.

    • To run your WordPress application on an in-place server, store the extracted file under the project root.

    • To run your WordPress application on a remote server, store the extracted files in your project and then configure automatic upload of them to the document root of the remote server.

      Learn more about server access configurations, see Configuring Synchronization with a Web Server. For information on configuring upload to the server, see Uploading and Downloading Files.

    • If you are not going to run your WordPress application but just need to get coding assistance from PhpStorm, store the extracted files anywhere on your computer. In this case, you will have to configure the installation as an include path, see Configuring Include Paths.

To run WordPress in the command line mode, you will need a set of command line tools, which you can acquire by installing the wp-cli/wp-cli package using the Composer dependency manager or by downloading the wp-cli.phar archive. For details, see Using the WordPress Command Line Tool WP-CLI.

Activate the WordPress installation in a project

  1. Open the project for which you'd like to enable WordPress integration.

  2. In the Settings/Preferences dialog (Ctrl+Alt+S), go to Languages and Frameworks | PHP | Frameworks.

  3. On the Frameworks page that opens, expand the WordPress node and select the Enable WordPress integration checkbox.

  4. In the WordPress installation path field, specify the folder where WordPress is installed. This folder should contain the wp-admin and wp-includes subdirectories.

  5. Click Apply to save the WordPress registration and click PHP.

  6. 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. Learn more in Configuring Include Paths.

Generate a WordPress application stub

During project creation, PhpStorm can generate a project stub for developing WordPress applications. The project structure is set up in accordance with the WordPress requirements.

  1. Select File | New | Project from the main menu or click Create New Project on the Welcome screen. The Create New Project Dialog opens.

  2. In the left-hand pane, select WordPress Plugin.

  3. In the right-hand pane, specify the folder where the project will be created.

    In the WordPress Installation Path field, specify the folder where WordPress is installed. This folder should contain the wp-admin and wp-includes subdirectories. Click Create to start the project stub generation.

  4. If the newly created project is outside the WordPress installation folder, configure it as an external library by adding it to the list of included path.

    1. In the Settings/Preferences dialog (Ctrl+Alt+S), go to Languages and Frameworks | 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. Learn more in Configuring Include Paths.

Last modified: 24 June 2019

See Also