PhpStorm 2019.3 Help

Working with source code

When you work with code, PhpStorm ensures that your work is stress-free. It offers various shortcuts and features to help you add, select, copy, move, edit, fold, find occurrences, and save code.

For navigation inside the editor, refer to Editor basics.

Find action

  • If you do not remember a shortcut for the action you want to use, press Ctrl+Shift+A to find any action by name.

You can use the same dialog to find classes, files, or symbols. For more information, refer to Search for a target by name (Search everywhere).

Add a new class, file, package, or scratch file

  • In the editor, press Ctrl+Alt+Insert to add a class, file, or package.

    If the focus is inside the Project tool window and you want to add a new element, press Alt+Insert.

  • To create a new Scratch file, press Ctrl+Shift+Alt+Insert.

    PhpStorm creates a temporary file that you can run and debug. For more information, refer to Scratch files.

Toggle read-only attribute of a file

If a file is read-only, it is marked with the closed lock icon the Locked icon in the status bar, in its editor tab, or in the Project Tool Window. If a file is writable, it is marked with the open lock icon the Unlocked icon in the Status bar.

  1. Open file in the editor or select it in the Project tool window.

  2. Do one of the following:

    • From the main menu, select File | Make File Read-only, or File | Make File Writable.

    • Click the lock icon in the status bar.

If a read-only status is set by a version control system, it's suggested that you use PhpStorm version control integration features. For more information, see Version control.

Select code constructs

  • In the editor, place the caret at the item you want to select and press Ctrl+W/ Ctrl+Shift+W to extend or shrink your selection.

    For example, in a plain text file, the selection starts within the whole word then extends to the sentence, paragraph, and so on.

    In a PHP file, if you start by selecting an argument in a method call, it will extend to all arguments, then to the whole method, then to the expression containing this method, then to a larger block of expressions, and so on.

  • If you need just to highlight your braces, place the caret immediately after the block closing brace/bracket or before the block opening brace/bracket.

Select code according to capitalization

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General | Smart Keys.

  2. Select the Use "CamelHumps" words checkbox.

If you want to use double-click when selecting according to capitalization, make sure that the Honor CamelHumps words... checkbox is selected on the Editor | General page of the Settings/Preferences dialog Ctrl+Alt+S.

Select occurrences

You can quickly locate all occurrences of the selected element in a file, make a multiple selection, or select the next or the previous occurrences.

  • To make a multiple selection of occurrences in a file, select the needed element in your code, then press Alt+J. Press the same key to find the next occurrence.

    Alternatively, keeping Alt pressed, double-click or drag over the text you want to add to the selection.

  • To move the caret to the next or the previous occurrence, press F3 or Shift+F3 respectively.

    When you pressF3, PhpStorm automatically removes the selection of the current occurrence and selects the next one.

  • To select all occurrences in the file, press Ctrl+Shift+Alt+J.

  • To find the next or the previous occurrence of the selected identifier, press Alt+Wheel up or Alt+Wheel down.

Copy and paste code

You can use the standard shortcuts to copy Ctrl+C and paste Ctrl+V any selected code fragment. If nothing is selected, PhpStorm automatically copies the whole line where the caret is located.

By default, when you paste anything in the editor, PhpStorm performs "smart" paste, for example, pasting multiple lines in comments will automatically add the appropriate markers to the lines you are pasting. If you need to paste just plain text, press Ctrl+Shift+Alt+V.

  • Place the caret at a line or a symbol and press Ctrl+Shift+Alt+C/Ctrl+V.

  • PhpStorm keeps track of everything you copy to the clipboard. To paste from history, press Ctrl+Shift+V. In the dialog that opens, select your entry and click Paste.

In the PHP context, PhpStorm can also automatically remove the opening and closing <?php ?> tags when you paste PHP code snippets. To customize this behavior, in the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General | Smart Keys page.

Lines of code

PhpStorm offers several useful shortcuts for manipulating code lines.

  • To add a line after the current one, press Shift+Enter. PhpStorm moves the caret to the next line.

  • To add a line before the current one, press Ctrl+Alt+Enter. PhpStorm moves the caret to the previous line.

  • To duplicate a line, press Ctrl+D.

  • To sort lines alphabetically in the whole file or in a code selection, from the main menu, select Edit | Sort Lines or Edit | Reverse Lines. These actions might be helpful when you work with property files, data sets, text files, log files, and so on. If you need to assign shortcuts to those actions, refer to Configuring keyboard shortcuts for more information.

  • To delete a line, place the caret at the line you need and press Ctrl+Y.

  • To join lines, place the caret at the line to which you want to join the other lines and press Ctrl+Shift+J. Keep pressing the keys until all the needed elements are joined.

    You can also join string literals, a field or variable declaration, and a statement. Note that PhpStorm checks the code style settings and eliminates unwanted spaces and redundant characters.

  • To split string literals into two parts, press Ctrl+Enter.

    PhpStorm also offers a set of handy intention actions for manipulating string literals, such as splitting a string into two concatenated strings or converting it to a sprintf call. To view the available actions, position the caret inside the string literal and press Alt+Enter or click the Intention action button.

  • To comment a line of code, place the caret at the appropriate line and press Ctrl+/.

  • To move a line up or down, press Shift+Alt+Up or Shift+Alt+Down respectively.

  • To move (swap) an XML or HTML tag attribute to the left or to the right, place the caret at it, or select it and press Ctrl+Shift+Alt+Left for left or Ctrl+Shift+Alt+Right for right.

Code statements

Move statements

  • In the editor, place the caret at the needed statement and press Ctrl+Shift+Up to move a statement up or Ctrl+Shift+Down to move a statement down. PhpStorm moves the selected statement performing a syntax check.

Complete current statement

  • In the editor, press Ctrl+Shift+Enter. PhpStorm inserts the required trailing comma automatically in structs, slices, and other composite literals. The caret is moved to the position where you can start typing the next statement.

Unwrap or remove statement

  1. Place the caret at the expression you want to remove or unwrap.

  2. Press Ctrl+Shift+Delete.

    PhpStorm shows a popup with all actions available in the current context. To make it easier to distinguish between statements to be extracted and statements to be removed, PhpStorm uses different background colors.

    Select a statement to unwrap
  3. Select an action and press Enter.

    Unwrapping result

Code fragments

  • Move and copy code fragments by dragging them in the editor.

    • To move a code fragment, select it and drag the selection to the target location.

    • To copy a code selection, keeping Ctrl pressed, drag it to the target location.

    The drag functionality is enabled by default. To disable it, in the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General and clear the Enable Drag'n'Drop functionality in editor checkbox in the Mouse section.

  • To toggle between the upper and lower case for the selected code fragment, press Ctrl+Shift+U.

    Note that when you apply the toggle case action to the CamelCase name format, PhpStorm converts the name to the lower case.

  • To comment or uncomment a code fragment, select it and press Ctrl+Shift+/.

    To configure settings for commenting behavior, use options in the Comment Code section, on the Code Generation tab located in the language-specific pages under Settings/Preferences | Editor | Code Style.

Multiple carets

You can edit multiple lines simultaneously. For example, you can add comment markers to multiple lines, or remove some characters in several occurrences of a word.

  • To add or remove multiple carets, press and hold Alt and click at the next location of the caret.

    Alternatively, to add multiple carets, you can press Ctrl twice, and then without releasing it, press the Up or Down arrow keys. You can also make a multiple selection by pressing Ctrl and dragging the caret.

  • To delete all added carets, press Escape.

  • You can make a multiple selection of code in columns. To enable or disable the column selection mode, press Shift+Alt+Insert or use the context menu of the editor.

    This mode is helpful when you want to edit several lines of code simultaneously. Place the caret at a symbol you need and either drag it up or down, or select a block of code and press the specified shortcut to achieve the same result.

    You can change the behavior of the caret move when you press Ctrl+Arrows (on Windows and Linux) and ⌥+Arrows (on macOS). The default behavor is to move the caret to the end of the current word. To change this setting, open settings Ctrl+Alt+S and navigate to Editor | General. In the Caret Movement section, select an appropriate behavior from the list.

    Column selection mode

Code folding

Folded code fragments are shown as shaded ellipses (Folded fragment). If a folded code fragment contains errors, PhpStorm highlights the fragment in red.

To configure the default code folding behavior, in the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General | Code Folding.

Expand or collapse code elements

  • To fold or unfold a code fragment, press Ctrl+NumPad -/Ctrl+NumPad Plus. PhpStorm folds or unfolds the current code fragment, for example, a single method.

  • To collapse or expand all code fragments, press Ctrl+Shift+NumPad -/Ctrl+Shift+NumPad Plus.

    PhpStorm collapses or expands all fragments within the selection, or, if nothing is selected, all fragments in the current file, for example, all methods in a file.

  • To collapse or expand code recursively, press Ctrl+Alt+NumPad -/Ctrl+Alt+NumPad Plus. PhpStorm collapses or expands the current fragment and all its subordinate regions within that fragment.

  • To fold blocks of code, press Ctrl+Shift+.. This action collapses the code fragment between the matched pair of curly braces {} and creates a custom folding region for that fragment and makes it "foldable".

  • To collapse or expand doc comments in the current file, in the main menu select Code | Folding | Expand doc comments/Collapse doc comments.

  • To collapse or expand a custom code selection, press Ctrl+..

    You can fold or unfold any manually selected regions in code.

Fold or unfold nested fragments

  • To expand the current fragment and all the nested fragments, press Ctrl+NumPad *, 1. You can expand the current fragment up to the specified nesting level (from 1 to 5).

  • To expand all the collapsed fragments in the file, press Ctrl+Shift+NumPad *, 1. You can expand the collapsed fragments up to the specified nesting level (from 1 to 5).

Use the Surround With action

You can collapse or expand code using the Surround With action.

  1. In the editor, select a code fragment and press Ctrl+Alt+T.

  2. In the popup menu, select <editor-fold...> Comments or region...endregion Comments.

  3. If you need, name your custom region and collapse or expand the created region as usual Ctrl+NumPad -/Ctrl+NumPad Plus.

  4. Press Ctrl+Alt+. to navigate to the created custom region.

Disable code folding outline

You can disable the code folding outline that appears on the left gutter.

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General | Code Folding.

  2. Clear the Show code folding outline checkbox.

Autosave

PhpStorm automatically saves changes that you make in your files. Saving is triggered by various events, such as compiling, running, debugging, performing version control operations, closing a file or a project, or quitting the IDE. Most of the actual events are predefined and cannot be configured, but you can be sure that changes will not be lost as you work.

Configure autosave behavior

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Appearance and Behavior | System Settings.

  2. Under Synchronization, configure the following options:

    • Save files on frame deactivation (when you switch to a different application)

    • Save files automatically if application is idle for N seconds

Mark files with unsaved changes

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General | Editor Tabs.

  2. Select the Mark modified tabs with asterisk checkbox.

Revert changes

Last modified: 9 December 2019