PhpStorm 2018.1 Help

Live Templates

File | Settings | Editor | Live Templates for Windows and Linux
PhpStorm | Preferences | Editor | Live Templates for macOS
Ctrl+Alt+S settings

Use this page to create, manage, and edit live templates.

On this page:

List of available live templates

ItemTooltip and shortcutDescription
By default expand withUse this drop-down list to specify the default invocation key for all templates. Individual expansion keys for the particular templates are defined in the editing area.

If the standard expansion keys (Tab, Enter, or Space) are not desirable, select the Custom option from this drop-down list.

When Custom is selected, the Change link appears next to the drop-down, leading you to the Keymap page.

Live TemplatesThis list shows all currently available template abbreviations supplied with their descriptions. The abbreviations are grouped below nodes and sorted alphabetically within each group. To activate a template or an entire group, select the checkbox to its left.
  • Only active templates are displayed upon invoking live templates in the editor.
  • If a template is active, the editor is sensitive to its abbreviation. Otherwise, the abbreviation is considered merely a set of characters.
add,png Add
Click this button to have a new template item added to the current group of template. You can define the template abbreviation, description, text, variables, expansion key, and context in the editing area below.
delete.png Remove
Click this button to have the selected live template removed from the list.
copy.gif DuplicateClick this button to create a new template based on the selected template. A new template item is added to the current node and the fields in the Template Text area show the definition of the selected template.
restore defaultsRestoreClick this button to restore the deleted live templates. This button is only enabled when the changes are applied.

Context menu of a live template

MoveChoose a group to move the selected template to.
Change contextChoose this command to modify the set of contexts where the current template is enabled. Upon choosing this command, a list of supported language contexts is displayed. To make PhpStorm consider a context sensitive to the template, select a checkbox next to the context name.

The available context types depend on the enabled plugins.

CopyChoose this command to create a serialized template XML in the system clipboard.
PasteChoose this command to paste an XML representation of the copied templates to the selected group of templates.
Restore defaultsThis command only appears on the context menus of the modified templates, marked blue. Choose this command to restore the default template settings.

Template editing area

The focus is moved to this area in the following cases:

  • When you click the Add add,png or Copy  copy.gif button.
  • When you select a live template in the list.
  • When you select a fragment of code in the editor and choose Tools | Save as Live Template.

Use controls of this area to create new live templates and edit the settings for the existing ones.

You can navigate through the Template Text Area using the hot keys that are marked in the field labels.

Abbreviation In this text box, specify the template abbreviation, i.e a sequence of characters that identify the template in the editor.
DescriptionIn this text box, provide optional description of a template or an example of its usage.
Template TextIn this text box, type the template body that may contain plain text and variables in the format $<variable name>$. If necessary, click Edit Variables and configure the variables as required. To escape a dollar sign ($) in the template text, just duplicate it ($$).
Applicable in:This read-only field shows the languages and/or pieces of code where the editor should be sensitive to the template. Upon pressing Ctrl+J in such context, PhpStorm displays a list of templates that are valid for this context.
Change Click this link to modify the set of contexts where the current template is enabled. Upon clicking the link, a list of supported language contexts is displayed. To make PhpStorm consider a context sensitive to the template, select a checkbox next to the context name.

The available context types depend on the enabled plugins.

Edit Variables Click this button to open the Edit Template Variables dialog box, where you can define how PhpStorm should process template variables upon template expansion. The Edit Template Variables dialog box contains a complete list of available functions. See the list of predefined functions below on this page.

The Edit Variables button is enabled only if the template body contains at least one user-defined variable, that is, a variable different from $END$ or $SELECTION$.

OptionsIn this area, define the behavior of the editor when a template is expanded.
  • Expand with - from this drop-down list, choose the key to invoke the template.
  • Reformat according to style - select this checkbox to have PhpStorm automatically reformat the expanded text according to the current style settings, defined on the Code Style.

Predefined functions to be used in live template variables

camelCase(String)Converts a string into cameCase. For example, camelCase(my-text-file), camelCase(my text file), and camelCase(my_text_file) all return myTextFile.
capitalizeAndUnderscore(sCamelCaseName)Capitalizes all the letters of a CamelCase name passed as parameter, and inserts an underscore between the parts. For example, capitalizeAndUnderscore(FooBar) returns FOO_BAR.
capitalize(String)Capitalizes the first letter of the parameter.
classNameComplete()This expression substitutes for the class name completion at the variable position.
clipboard()Returns the contents of the system clipboard.
complete() Invokes code completion at the position of the variable.
completeSmart() Invokes smart type completion at the position of the variable.
date(sDate) Shows the current system in the specified format.

By default, the current date is returned in the default system format. However, if you specify date format in double quotes, the date will be presented in this format:

decapitalize(sName)Replaces the first letter of a name parameter with the corresponding lowercase letter.
enum(sCompletionString1,sCompletionString2,...)Shows a list of comma-separated strings suggested for completion at the template invocation.
escapeString(sEscapeString)Escapes a string.
expectedType()Returns the expected type of the expression into which the current template expands. Makes sense if the template expands in the right part of an assignment, after return, etc.
fileName()Returns the name of a file with its extension.
fileNameWithoutExtension()Returns the name of a file without its.
firstWord(sFirstWord)Returns the first word of a string.
JsArrayVariable Returns the name of the current JavaScript array.
jsClassName()Returns the name of the current JavaScript class.
jsComponentTypeOf() Returns the type of the current JavaScript component.
jsMethodName()Returns the name of the current JavaScript method.
jsQualifiedClassName Returns the complete name of the current JavaScript class.
jsSuggestIndexName Returns a suggested name for an index.
jsSuggestVariableName Returns the suggested name for a variable.
lineNumber()Returns the current line number.
lowercaseAndDash(String) Converts a capitalized camelCase string into lower case and inserts n-dashes as separators. For example, lowercaseAndDash(MyExampleName) returns my-example-name.
snakeCase(String) Converts a string into snake_case, for example, snakeCase(fooBar) returns foo_bar.
spaceSeparated(String) Converts a CamelCase string into lower case and inserts spaces as separators. For example, spaceSeparated(fooBar) returns foo bar.
substringBefore(String,Delimiter) Removes the extension after the specified delimiter and returns only the file name. This is helpful for test file names, for example, substringBefore($FileName$,".") will return component-test in component-test.js.
time(sSystemTime)Returns the current system time.
timestamp()This function without parameters returns the current time in milliseconds from the 1st January 1970. Refer to the article Unix time.
underscoresToCamelCase(sCamelCaseText)Replaces underscores with CamelHump letters. For example, underscoresToCamelCase(foo_bar) returns underscoresToCamelCase(fooBar).
underscoresToSpaces(sParameterWithSpaces)Replaces underscores with spaces.
user()Returns the name of the current user.
Last modified: 13 February 2018

See Also