PhpStorm 2026.1 Help

ファイルテンプレート変数

ファイルテンプレートには変数を含めることができ、テンプレートが適用されるときにそれらは値に置き換えられます。 変数は、ドル記号 $ で始まり、その後に変数名が続く文字列です。 変数名は、省略可能で波括弧で囲むことができます。 例えば、 $MyVariable${MyVariable} は同じ変数の異なる表記法です。

事前定義された変数とカスタム変数は、テンプレート本体とファイル名で使用できます。 例: テンプレートの ファイル名 フィールドに MyFile_${MONTH_NAME_FULL} と入力した場合、4 月に作成すると、結果のファイルの名前は MyFile_四月 になります。 ここで、 ${MONTH_NAME_FULL}事前定義された変数です。 代わりに カスタム変数を使用すると、このテンプレートを基にファイルを作成するときに PhpStorm が変数の値の入力を求めます。

定義済みのテンプレート変数

次の事前定義済み変数をファイルテンプレートで使用できます:

変数

説明

${DATE}

現在のシステム日付

${DAY}

現在の月の日

${DS}

ドル記号 $。 この変数はドル文字をエスケープするために使用され、テンプレート変数の接頭辞として扱われません。

${FILE_NAME}

新しい PHP ファイルの名前

${HOUR}

現在の時間

${MINUTE}

現在の分

${SECOND}

現在の秒

${MONTH}

現在の月

${MONTH_NAME_FULL}

現在の月のフルネーム(January、February など)

${MONTH_NAME_SHORT}

現在の月名の最初の三文字(Jan、Feb など)

${NAME}

新しいエンティティの名前 (ファイル、クラス、インターフェースなど)

${NAMESPACE}

クラスまたはフィールドの名前空間の完全修飾名(先頭にスラッシュなし)

${PRODUCT_NAME}

IDE の命名(たとえば、PhpStorm)

${PROJECT_NAME}

現在のプロジェクトの命名

${TIME}

現在のシステム時刻

${USER}

現在のユーザーのログイン名

${YEAR}

現在の年

PhpStorm は、 PHP インクルードテンプレートのために、ファイルヘッダーや 再利用可能なコードPHPDoc コメントなどを定義するための追加変数セットを提供します。

次の追加の事前定義変数は、 PHP インクルードテンプレートで使用できます。

変数

説明

${CARET}

変数の編集が終了したら、キャレットの位置を指定します。 ファイル作成中に PHPDoc コメントが生成されて挿入された場合にのみ適用されます。 PHPDoc コメントが コード | 生成 | PHPDoc ブロック を介して作成された場合、関数やメソッドの複数選択が可能です。 この場合のドキュメントコメントは、いくつかのクラス、関数、メソッド、フィールドに対して作成することができるため、 ${CARET} 変数は無視されます。

${CLASS_NAME}

PHPDoc コメントを生成するフィールドまたはメソッドが定義されているクラスの名前

${NAME}

PHPDoc コメントが生成されるクラス、フィールド、関数(メソッド)の名前

${NAMESPACE}

クラスまたはフィールドの名前空間の完全修飾名(先頭にスラッシュなし)

${PARAM_DOC}

パラメーターのドキュメントコメント。 一連の @param type name 行を評価します。 コメントを生成する関数にパラメーターが含まれていない場合は、空の文字列に評価されます。

${STATIC}

PHPDoc コメントを生成する関数 (メソッド) またはフィールドが静的な場合は、 static キーワードに置き換えられます。 それ以外の場合は、空の文字列として評価されます。

${THROWS_DOC}

例外のドキュメントコメント。 一連の @throws type 行を評価します。 コメントを生成する関数が例外をスローしない場合は、空の文字列に評価されます。

${TYPE_HINT}

PHPDoc コメントを生成する関数(メソッド)の戻り値。 関数(メソッド)の静的解析によって戻り値の型を検出できない場合は、 void と評価されます。

変数メソッド

PhpStorm はファイルテンプレート用のテンプレートエンジンとして Velocityを使用しているため、ファイルテンプレート内の変数で Java 文字列メソッドが利用できます。 例: 次のことが可能です。

  • ${NAME.toUpperCase()}: 新しいエンティティ (ファイル) の名前を大文字に変換します。

  • ${PROJECT_NAME.length()}: プロジェクト名の長さを出力します。

  • ${PRODUCT_NAME.substring(0,5)}: 使用している IDE の名前の最初の 5 文字を出力します。

カスタムテンプレート変数

事前定義されたテンプレート変数に加えて、カスタム変数を指定することができます。 必要に応じて、 #set ディレクティブを使用して、テンプレート内でカスタム変数の値を定義できます。 対応する変数が使用される前にディレクティブを記述します。

例: 事前定義された変数 ${USER} で定義されたログイン名の代わりにフルネームを使用する場合は、カスタム変数の前に次の構成を追加します。

#set( $MyName = "John Smith" ) Created by: $MyName

テンプレート内で変数の値が定義されていない場合、PhpStorm はテンプレートが適用されたときにその入力を求めます。

2026 年 5 月 22 日