PhpStorm 2018.2 Help

Rename Refactorings


Rename refactorings allow you to rename symbols and files with all the references to them in the code corrected automatically.

The following rename refactorings are available in PhpStorm:

  • Rename Class. The following usages are renamed:
    • Import statements

    • Qualified names of classes

  • Rename Method. The following usages are renamed:
    • All calls of the method.

    • All overridden/implemented methods in subclasses.

  • Rename Field.


Renaming a symbol

To rename a symbol, follow these general steps

  1. Select the item to be renamed.
    • To select a file, click the desired file in the Project Tool Window.

    • To select a symbol in the editor, place the caret at the name of the symbol to be renamed.

    • To select a symbol in the Project Tool Window, make sure that the members are shown, and then click the desired symbol.

    • To select a symbol in the Structure view, click the desired symbol in the Structure tool window.

  2. Choose Refactor | Rename on the main menu or on the context menu, or press Shift+F6.

  3. The subsequent behavior depends on the checkbox Enable in-place mode (Settings/Preferences dialog, Editor).
    • If this checkbox is selected, the suggested name appears right below the symbol in question. You can either accept suggestion, or type a new name. However, if you press Shift+F6 once more, PhpStorm will display the Rename dialog box with more options.

    • If this checkbox is not selected, the Rename dialog box opens immediately.

    The set of controls and their names depend on the type of the symbol to be renamed.

  4. Preview and apply changes.

  5. If PhpStorm detects the symbol occurrences in comments and strings, it suggests to extend refactoring to that usages as well:
    cl renameStrings
    In this case:
    • Choose Show Usages to view that usages in Find Tool Window.

    • Choose Rename Only Code Usages to apply refactoring to code usages only.

    • Choose Rename All Usages to rename both code and non-code usages.

    • Click Cancel to terminate and return back.

Renaming a file or directory

To rename a file or directory

  1. Select a desired file in the Project tool window.

  2. Choose Refactor | Rename on the main or context menu or press Shift+F6.

  3. In Rename File dialog box that opens, specify the new file name. Select Search in comments and strings checkbox to let PhpStorm apply changes to comments and strings.

  4. Press Preview to observe possible changes in Find Tool Window. Press Refactor to proceed.

    PhpStorm finds all the occurrences of the file name and changes them respectively.

Important notes

Last modified: 21 November 2018

See Also