PhpStorm
 
2023.2
Shortcuts: Windows
Get PhpStorm
You are viewing the documentation for an earlier version of PhpStorm.
  1. Write and edit source code
  2. Generate code
  3. Generate custom code constructs using live templates

Generate custom code constructs using live templates

Last modified: 11 January 2023

PhpStorm provides a multitude of predefined live templates for many common code constructs. You can also define custom templates to cover use cases specific to your workflow.

Insert a live template

  1. Place the caret at the place where you want the template to expand.

  2. Type the template abbreviation and press the invocation key (usually Tab by default). Alternatively, on the Code menu, click Insert Live Template Ctrl0J to open the suggestion list and select the necessary template.

  3. If the selected template requires user input, the corresponding field is highlighted. Type the necessary value and press Enter or Tab to complete input and move to the next input field. After completing all input fields, the caret moves to the end of the construct (or to the $END$ marker if the marker is defined in the template code), and the editor returns to the regular mode of operation.

You can also wrap fragments of code using surround templates.

Surround a block of code with a live template

  1. Select a piece of code to be surrounded.

  2. On the Code menu, click Surround With CtrlAlt0J to open the suggestion list and select the necessary template.

Using live templates for smart completion of parameters in function calls

In the PHP context, you can use an “automatic” live template that provides completion lists for the parameters passed into functions, methods, or class constructors.

To enable smart completion of parameters:

  1. In the Settings dialog CtrlAlt0S, click Editor, then General, and then Smart Keys.

  2. Select the Enable smart function parameters completion checkbox in the PHP group.

To use smart completion templates for functions:

  • Type the params keyword as the first parameter in the function call.

    ps_smart_parameter_completion_step_1.png

    PhpStorm displays a live template where the parameters are automatically completed with the variable names defined in the function declaration.

    To move to the next parameter, press Enter or Tab. To move to the previous parameter, press ShiftTab.

    The completion list contains variables from the local scope in the following order: with the same type, with a similar name, defined nearby. You can always switch to the usual completion mode by pressing CtrlSpace or just typing anything that is not in the list. Variables with similar names are inserted automatically.