IntelliJ IDEA 2018.1 Help

File Template Variables

A file template can contain variables, which are replaced by their values. A variable is a string that starts with the dollar sign ($) and followed by the variable name. The variable name may optionally be enclosed in curly braces. For example: $MyVariable and ${MyVariable} are different notations of the same variable.

Predefined template variables

The following predefined variables can be used in file templates:

VariableDescription
${DATE}Current system date
${DAY}Current day of the month
${DS}Dollar character ($). This variable can be used to escape the dollar character, so it is not treated as a prefix of a variable.
${END}Caret position after you finish editing the variables
${FILE_NAME}Name of the new PHP file (if the PHP plugin is enabled)
${HOUR}Current hour
${MINUTE}Current minute
${MONTH}Current month
${MONTH_NAME_FULL}Full name of the current month (January, February, etc.)
${MONTH_NAME_SHORT}First three letters of the current month name (Jan, Feb, etc.)
${NAME}Name of the new entity (file, class, interface, and so on)
${PACKAGE_NAME}Name of the target package where the new class or interface file is created
${PRODUCT_NAME}Name of the IDE (for example, IntelliJ IDEA)
${PROJECT_NAME}Name of the current project
${TIME}Current system time
${USER}Login name of the current user
${YEAR}Current year

IntelliJ IDEA provides a set of additional variables for PHP include templates, which are used to define reusable pieces of code, such as, file headers and PHPDoc comments).

The following additional predefined variables can be used in PHP include templates:

VariableDescription
${CARET} Caret position after you finish editing the variables. Applied only when a PHPDoc comment is generated and inserted during file creation. When a PHPDoc comment is created through Code | Generate | PHPDoc block, multiple selection of functions or methods is available so documentation comments can be created to several classes, functions, methods, or fields. In this case, the ${CARET} variable is ignored.
${CLASS_NAME}Name of the class where the field to generate the PHPDoc comment for is defined
${NAME}Name of the class, field, or function (method) for which the PHPDoc comment will be generated
${NAMESPACE}Fully qualified name (without a leading slash) of the class or field namespace
${PARAM_DOC} Documentation comment for parameters. Evaluates to a set of lines @param type name. If the function to generate comments for does not contain any parameters, evaluates to empty string.
${STATIC} Is replaced by static if the function (method) or field to generate the PHPDoc comment for is static. Otherwise evaluates to an empty string.
${THROWS_DOC}Documentation comment for exceptions. Evaluates to a set of lines @throws type. If the function to generate comments for does not throw any exceptions, evaluates to empty string.
${TYPE_HINT} Return value of the function (method) to generate the PHPDoc comment for. If the return type cannot be detected through static analysis of the function (method), evaluates to void.

Custom template variables

Besides predefined template variables, it is possible to specify custom variables. If necessary, you can define the values of custom variables right in the template using the #set directive.

For example, if you want to use your full name instead of your login name defined through the predefined variable ${USER}, use the following construct:

#set( $MyName = "John Smith" )

If the value of a variable is not defined in the template, IntelliJ IDEA will ask you to specify it when the template is applied.

Last modified: 26 June 2018