PhpStorm 2018.3 Help

Creating Custom Inspections

In PhpStorm, you can create new inspections using the Structural Search Inspection. To create a custom inspection, you have to configure a search template and set a severity level. The IDE will search for code that matches the template and will highlight it in the editor according to the specified severity.

If you want your inspection to suggest fixes, you have to configure the replace template.

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), go to Editor | Inspections.

  2. Select the profile in which you want to create a new inspection.

  3. Locate the Structural Search Inspection in the list, and select its checkbox to enable it (the inspection is disabled by default).

  4. Click icons general add svg and select Add Search Template if you want your inspection to highlight code only, or Add Replace Template if you want your inspection to highlight code strings and suggest fixes.

  5. Configure the templates.

    You can use a sample template and configure it according to your needs. To do so, click Existing Templates and the select the suitable one.

    For more information on how to configure search and replace templates, refer to Structural Search and Replace.

    The Structural Replace dialog
  6. When finished, click Save Template and name the new template.

  7. Select inspection severity and scope. If an inspection is not associated with a scope, it applies to all the sources of the current project.

  8. Apply the changes and close the dialog.

Last modified: 18 March 2019

See Also