VS Code は開発で非常に便利なエディタで、使っておられる方も多いことでしょう。ただ、WordPress のソースといったような HTML を含んだ PHP のコードを自動成形する方法が分からずこまったので、備忘的にここにまとめてお来たいと思います。この記事では、HTML と PHP の両方を含むコードを自動的に整形する方法を紹介します。
必要な拡張機能のインストール
はじめに、VS Code に2つの必要な拡張機能をインストールする必要があります。
- Prettier – Code Formatter
これは広く使用されているコードフォーマッターです。デフォルトの状態では PHP の整形はできないので、HTML の整形をこの拡張機能で行います。 - PHP Intelephense
これも人気のあるフォーマッターで、PHP のコードを整形を行います。
これらのツールを組み合わせることで、HTML と PHP が混在するファイルも適切に整形することができます。
拡張機能のインストール方法
Prettierのインストール
- VS Codeを開き、拡張機能タブをクリックします。
- 検索バーに「Prettier」と入力し、表示された「Prettier – Code Formatter」を選択してインストールします。
PHP Intelephenseのインストール
- 同じく拡張機能タブを開き、「PHP Intelephense」と検索します。
- 表示された拡張機能を選択してインストールします。
設定方法
自動整形の設定
- VS Code 上でショートカット「Command (⌘) + , 」を押して設定画面を開きます。
- 検索窓に「Editor:Format」と入力し、「Editor: Default Formatter」で「PHP Intelephense」をデフォルトのフォーマッターとして選択します。
- また、「Editor: Format On Save」のオプションにチェックを入れることで、ファイルを保存するたびに自動的に整形されるようになります。
この設定により、HTML と PHP コードが混在していても、VS Code がファイルを保存する際に自動的に整形を行います。これで、コーディング中の手間を減らし、より効率的に作業をすることができます。