ファイルテンプレート

ファイルテンプレートは、プロジェクトツリーのコンテキストメニューのファイル | 新規メニューまたは新機能セクションを使用して作成する新しいファイルの既定の内容の仕様です。

作成するファイルの種類に応じて、テンプレートは、その種類のすべてのファイルに期待される初期コードとフォーマットを提供します (業界または言語の標準、企業ポリシー、その他の理由に従って)。

PhpStorm は、新しいファイルを作成するときに提案される、サポートされているすべてのファイルタイプの定義済みテンプレートを提供します。

ファイルテンプレートの管理と構成

Ctrl+Alt+S を押して設定を開き、エディター | ファイルおよびコードテンプレートを選択します。

詳細は、 Karma を参照してください。

デフォルトでは、テンプレートのリストには PhpStorm が提供する定義済みテンプレートのみが含まれます。その一部は内部テンプレートであり、削除や名前の変更はできません。 PhpStorm では、内部テンプレートの名前が太字で表示されます。変更したテンプレートの名前と、手動で作成したカスタムテンプレートの名前は青色で表示されます。

次の手順では、ファイルテンプレートを作成する方法について説明します。インクルードテンプレートの作成にも同様の手順を使用できます。

新しいファイルテンプレートを作成する

Ctrl+Alt+S を押して設定を開き、エディター | ファイルおよびコードテンプレートを選択します。
スキームリストを使用して、ファイルテンプレートが適用されるスコープを選択します。
- Default: IDE レベルで作成されたファイルテンプレート。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。 PhpStorm は、グローバルテンプレートを fileTemplates の IDE 構成ディレクトリに保存します。
- Project: 現在のプロジェクトに固有のファイルテンプレート。これらのテンプレートは、このプロジェクトで作業するすべてのユーザーが利用できます。 PhpStorm は、 .idea/fileTemplates のプロジェクトフォルダーに保存します。
ファイルタブで、をクリックし、テンプレート名、ファイル拡張子、結果のファイルの名前、テンプレートの本体を指定します。
変更を適用し、ダイアログを閉じます。

既存のファイルテンプレートをコピーする

Ctrl+Alt+S を押して設定を開き、エディター | ファイルおよびコードテンプレートを選択します。
ファイルタブで、をクリックし、必要に応じてテンプレートの名前、ファイル拡張子、本文を変更します。
変更を適用し、ダイアログを閉じます。

ファイルをテンプレートとして保存する

エディターでファイルを開きます。
メインメニューでファイル | ファイルをテンプレートとして保存へ移動します。
「ファイルをテンプレートとして保存」ダイアログで、新しいテンプレート名と拡張子を指定し、必要に応じて本文を編集します。ファイルテンプレートで使用される構文の詳細については、「構文」を参照してください。
- ファイル名: 必要に応じて、このテンプレートから作成されるファイルの名前を指定します。デフォルトでは、PhpStorm はファイルを追加するときにユーザーに名前の入力を求めます。特定の名前をハードコードしてプロンプトを完全に回避したり、使用可能な変数からテンプレートを作成したりできます。例: 指定した名前を使用して、ファイル作成時に選択したディレクトリの 1 つ上のディレクトリに置く方法を次に示します: ../${NAME}
- スタイルに応じて整形: このファイルタイプに定義されたコードスタイルに従って、このテンプレートに基づいて生成されたコンテンツを再フォーマットします。
- Velocity エスケープ構文を使用して、ライブテンプレート変数をファイルテンプレートに含めます（例： #[[ $MY_VARIABLE$ $END$ ]]#）。 Velocity エスケープ構文を使用して、ライブテンプレート変数をファイルテンプレートに含めます（例： #[[ $MY_VARIABLE$ $END$ ]]#）。
変更を適用し、ダイアログを閉じます。

構文

ファイルテンプレートでは Velocity Template Language (VTL) を使用します。これには次の構文が含まれます:

プレーンテキストはそのままレンダリングされます。
値に置き換えられる変数。例: ${NAME} は、ファイルを追加するときにユーザーが指定した名前を挿入します。
#parse、 #set、 #if などを含むさまざまなディレクティブ。

$ または # の入力を開始して、使用可能な変数およびディレクティブの補完候補を参照します。

詳細については、 VTL リファレンスガイド(英語)を参照してください。

次の例は、PhpStorm で PHP クラスを作成するためのデフォルトのテンプレートを示しています。

                <?php
                #parse("PHP File Header.php")

                #if (${NAMESPACE})

                namespace ${NAMESPACE};

                #end

                class ${NAME} {

                }

このテンプレートは、次のように構成されています。

#parse 指示文は、 PHP File Header.php テンプレートの内容を挿入するために使用されます。
#if ディレクティブは、名前空間が空でないかどうかをチェックするために使用されます。そうでない場合は、その名前が namespace ステートメントに ${NAMESPACE} 値として追加されます。
テンプレートは、 ${NAME} 値（新しいファイルの名前）として渡された名前を持つクラスを宣言します。

テンプレートに基づいて新しい PHP クラスを作成すると、次のような内容のファイルが生成されます。

                <?php
                /**
                * Created by PhpStorm.
                * User: jetbrains
                * Date: 03/07/2018
                * Time: 16:16
                */

                namespace My\Name;

                class MyClass
                {

                }
            
  

2026 年 11 月 9 日