PhpStorm 2024.3 Help

Write and edit 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.

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:

    • Go to File | File Properties | Make File Read-only or File | File Properties | 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, refer to Version control.

Transpose characters

  1. In the editor, place the caret at the characters you want to swap.

  2. Go to Edit | Transpose.

    There is no default shortcut for this action. You can assign a custom shortcut.

Floating toolbar

The floating toolbar contains various actions for code editing. It appears when you select a code fragment in PHP, JSON, XML, YAML, and SQL files in the editor.

Floating toolbar for code editing

Enable the toolbar

  1. Press Ctrl+Alt+S to open settings and then select Advanced Settings.

  2. In the Editor section, disable the Hide floating toolbar for code selection option.

  3. Apply the changes and close the dialog.

Customize the toolbar

  1. Press Ctrl+Alt+S to open settings and then select Appearance & Behavior | Menus and Toolbars.

    Alternatively, click More on the toolbar and select Customize Toolbar.

  2. Add or remove actions under Floating Code Toolbar.

    For more information, refer to Menus and toolbars.

  3. Apply the changes and close the dialog.

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, go to 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 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, place the caret inside the string literal and press Alt+Enter or click the Intention action button.

    Applying string manipulation intentions
  • To comment a line of code, place the caret at the appropriate line and press Ctrl+/. Press Ctrl+/ again on the same line to uncomment it.

  • To move a line up or down, press Alt+Shift+Up or Alt+Shift+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+Alt+Shift+Left for left or Ctrl+Alt+Shift+Right for right.

    Move XML attribute left or right

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 as is 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+Alt+Shift+V.

  • When you copy (Ctrl+C) or cut (Ctrl+X) a line without any code selected, the paste action will add the contents of the clipboard to above the current line, not at your caret.

    If you want to paste your copied code at the caret, select the Paste at the caret position option in the advanced settings.

  • Place the caret at a line or a symbol, right-click to open the context menu, select Copy/Paste Special | Copy Reference. When you select the Copy Reference (Ctrl+Alt+Shift+C) option, PhpStorm creates a reference string that includes the line number of the selected line or symbol. You can press Ctrl+V to paste the copied reference anywhere.

  • PhpStorm keeps track of everything you copy to the clipboard. To paste from history, in the editor, from the context menu, select Copy/Paste Special | Paste from History (Ctrl+Shift+V). In the dialog that opens, select your entry and click Paste.

  • When you copy and paste code to the editor, PhpStorm displays the hidden (special) characters represented by their Unicode name abbreviation.

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 dialog (Ctrl+Alt+S) , go to Editor | General | Smart Keys page.

Code selection

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.

    Code selection
  • 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 dialog (Ctrl+Alt+S) , go to Editor | General | Smart Keys.

  2. Select the Use "CamelHumps" words checkbox.

If you want to select words with a double click according to capitalization, make sure that the Honor "CamelHumps" words settings when selecting on double click checkbox right below is also selected.

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 or from the main menu select Code | Complete Current Statement. 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 or select Code | Unwrap/Remove from the main menu.

    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 dialog (Ctrl+Alt+S) , go to Editor | General and clear the Move code fragments with drag-and-drop checkbox in the Mouse Control 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 | Editor | Code Style.

Code folding

PhpStorm automatically recognizes certain code structures and makes them foldable. You can also define custom folding regions.

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

By default, folding icons in the gutter show up on hover. You can change this and configure other code folding settings in Settings | Editor | General | Code Folding.

Go to Help | Find Action in the main menu (Ctrl+Shift+A) and search for folding. PhpStorm will show a popup with all folding actions with their shortcuts:

Expand or collapse code elements

  • To fold or unfold a code fragment, press Ctrl+NumPad -/Ctrl+NumPad +. 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 +.

    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 +. PhpStorm collapses or expands the current fragment and all its subordinate regions within that fragment.

  • To fold a block of code inside a pair of matching curly braces {}, press Ctrl+NumPad -. To expand the block, press Ctrl+NumPad +.

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

  • To collapse or expand a custom code fragment, select it and press Ctrl+.. Alternatively, mark the code fragment as Custom folding region.

    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).

Custom folding regions

You can make any code fragment foldable by marking it as a custom folding region with dedicated comments. After that, you can expand and collapse the fragment with Ctrl+. or have it collapsed automatically on opening the file.

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

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

  3. Optionally, specify a description under which the collapsed fragment will be hidden.

  4. To collapse or expand the created region, press Ctrl+..

  5. To navigate to the created custom region, press Ctrl+Alt+..

Configure code folding icons

You can select how to display folding icons that appear in the gutter or disable them completely.

  1. Press Ctrl+Alt+S to open settings and then select Editor | General | Code Folding.

  2. From the Show code folding arrows list, select Always or On mouse hover.

    Clear the checkbox to disable the icons.

Last modified: 16 October 2024