PhpStorm 2021.2 Help

Code refactoring

Refactoring is a process of improving your source code without creating a new functionality. Refactoring helps you keep your code solid , dry, and easy to maintain.

Invoke refactoring

  1. Select an item to refactor. You can select a file/folder in the Project tool window or expression/symbol in the editor.

  2. Press Ctrl+Alt+Shift+T to open a list of refactorings that can be selected.

    refactor this popup

    Alternatively, you can use a keyboard shortcut for a specific refactoring.

If you need to undo your refactoring, press Ctrl+Z.

Preview refactoring changes

For some refactorings, PhpStorm lets you preview changes before applying them.

  1. To see potential changes (the list of usages where the refactoring will be performed), click Preview in the Refactoring Preview dialog.

    Refactoring dialog
  2. Check the changes that are going to be made in the Find tool window. You can exclude Delete or remove Ctrl+X changes that you consider unnecessary.

    Refactoring preview

  3. Click Do Refactor to proceed with the changes.

Resolve conflicts

When PhpStorm encounters problems with your refactoring, it opens a dialog with the list of conflicts and their brief descriptions.

Refactoring conflicts dialog
  • Click Continue to ignore the problem and proceed to open the preview in the Find tool window.

  • Click Show Conflicts in View to open the conflict entries in the Find tool window and deal with them further.

    For example, you can try to exclude an entry from refactoring by pressing Delete or click Cancel and return to the editor.

    Refactoring conflicts tool window

    Configure refactoring settings

    1. In the Settings/Preferences dialog Ctrl+Alt+S, select Editor | Code Editing.

    2. On the Code Editing page, in the Refactorings section, adjust the refactoring options and click OK.

    Safe Delete

    Alt+Delete

    Makes sure that you do not delete files that are referenced in your source code.

    Safe delete

    Copy/Move

    F5/F6

    Copies/Moves an element.

    Move Refactorings

    Extract Method

    Ctrl+Alt+M

    These refactoring actions help you reduce the code duplication.

    Extract method

    Extract Constant

    Ctrl+Alt+C

    Declares a new constant and initializes it with the selected expression.

    Extract constant

    Extract Field

    Ctrl+Alt+F

    Declares a new class property and initializes it with the selected expression.

    Extract field

    Extract Parameter

    Ctrl+Alt+P

    Adds a new parameter to a method declaration and updates the method calls accordingly.

    Extract parameter

    Introduce Variable

    Ctrl+Alt+V

    Declares a new variable and initializes it with the selected expression.

    Extract/Introduce variable

    Rename

    Shift+F6

    Renames an element.

    Rename refactorings

    Inline

    Ctrl+Alt+N

    Inlines an element. Acts as opposite of extracting.

    Inline

    Change signature

    Ctrl+F6

    Changes the call signature of a method.

    Change signature

    Last modified: 22 November 2021