PhpStorm 2024.1 Help

Structural search and replace

A conventional search process does not take into account the syntax and semantics of the source code. Even if you use regular expressions, PhpStorm still treats your code as a regular text. The structural search and replace (SSR) actions let you search for a particular code pattern or grammatical construct in your code considering your code structure.

PhpStorm finds and replaces fragments of source code, based on the search templates that you create and conditions you apply.

Search for a target structurally

  1. Go to Edit | Find | Search Structurally to open the Structural Search dialog.

  2. In the Structural Search dialog, do one of the following:

    • Create your own template from scratch.

      Select Draft Template from the list of templates.

      In the editor area, enter the code template ($variable$ that represents your code), in the dialog's toolbar click the Save Template button to save it for future use. You can opt to save the template as inspection as well.

      Structural Search dialog

      PhpStorm adds the created template to the existing template list (Recent node).

    • Use one of the existing templates to act as a prototype.

      In the list of available existing templates, select the needed template.

      Consider the following example class:

      class ExampleClass { public function WRONG() { } public function right() { } }

      Let's find a certain method in the class.

      In the list of existing templates, select the All public methods of the class template under PHP | General.

      the Existing Templates dialog

      Click Find.

      PhpStorm instantly highlights the found code occurrences in the editor.

  3. The Structural Search dialog displays the selected template and the values of the filters used in the template. You can edit the existing filters or add new conditions. Place the caret at the code variable and use the filter area to manage filters.

    the Edit filters popup
  4. As an example, let's add a condition for the $b$ variable.

    In the filter area, click the Add button to add a new condition. If, for example, you need to add a regular expression, select Text. You can also add other conditions depending on your variable.

  5. In the field that opens, type your condition.

    For example, let's type the following regular expression:

    Add regular expression to the filter dialog

    In this case when you select the Match case checkbox in the Structural Search dialog, PhpStorm will only search for the fields with uppercase characters.

    Also note there are different additional options are available depending on the selected language.

    For example, check the following options:

    • Language: use the list to select, which file types should be a part of the search. In our case, it is PHP.

    • Target: in the list of options, select what item to search for. In our case it is b).

      Search target
    • Recursive: if this checkbox is selected, PhpStorm performs the recursive search and all nested items will be included in the results. For example, when you search for a method call, with the Recursive option enabled, PhpStorm will find nested method calls in foo(foo(foo())). With the Recursive option disabled, only the outer method call will be found.

    • Injected code: if this checkbox is selected, the injected code such as JavaScript that is injected in HTML code or SQL injected in Java will be a part of the search process.

    • Match case: if this checkbox is selected, the search result will match the case of a search target.

  6. Specify where to search: in a project, module, directory, or within a custom scope.

    Click Find.

    PhpStorm displays the results in the Find tool window.

    Find tool window results

    You can add the newly created search template to structural search inspections as a custom template by clicking Create Inspection from Template in the Find tool window and use it later to inspect your code.

Replace a target structurally

  1. In the main menu, go to Edit | Find | Replace Structurally.

  2. In the Replace Structurally dialog, add new or existing templates to the search and replace template areas. You can save the replace template the same way as the search one.

  3. If you need to add a filter for the variable in the replace template, place the caret at the variable of interest and use the filter area to manage filters.

    Replace template filter
  4. In the filter area, depending on what you chose as a filter, specify the condition.

  5. To narrow down your replace results, select the following options:

    • Shorten fully-qualified names - replaces fully qualified class names with short names and imports.

    • Reformat - automatically formats the replaced code.

    • Use static import - uses static import in replacement when possible.

    After specifying the necessary options, click Find. PhpStorm displays the results in the Find tool window.

  6. In the Find tool window, you can work with the results further, replacing found items one by one, or all of them at once, or previewing your potential changes.

Consider the following example that converts uppercase values of the class attribute in p tags to lowercase. In the Search template field, we create a template that searches for all p tags with uppercase values ([A-Z].* and Match case) in class attributes. We narrow our search only to these to class values (Search target = b). In the Replace template field, we create a new variable $d$ and assign a Groovy script to it (b.getText().toLowerCase()). After the search, we select Replace All to perform the replacing.

Share search templates

You can share a search template with your peers by exporting or importing it.

  1. In the Structural Search dialog (Edit | Find | Search Structurally), create a new search template or use the existing one.

  2. To export a template, click the Export Template to Clipboard icon. PhpStorm adds the XML representation of the template to a clipboard (press Ctrl+Shift+V to see the clipboard's content). You can share this representation with other developers in chat, email, or a forum.

    To import a template, copy (Ctrl+C) the shared XML code from anywhere (email, chat, or a forum) and in the Structural Search dialog, click the Import Template from Clipboard icon. PhpStorm takes the XML code representation and converts it into a template including variables and a scope if it is present.

Last modified: 26 May 2024