Windows環境に「PHP_CodeSniffer」と「WordPress-Coding-Standards」を入れる!

前提 XAMPPが導入されていること

XAMPPをインストールすると、PHPであったりPEARであったり、今回の作業に必要なツール(コマンド)を提供してくれるのでインストールしてください。

イントールフォルダは、デフォルト(C:\xampp)で大丈夫です。

あと、環境変数として「C:\xampp\php」を登録しておかないとコマンドが使えませんのでご注意を。

https://www.apachefriends.org/jp/index.html

PHP_CodeSnifferのインストール

実はXAMPPをインストールした時点で、php_codesnifferは入っています。しかし、めちゃくちゃ古いのです。

バージョンを確認してみましょう。

※ ここから先はすべてXAMPPのコマンドプロンプトを起動して行います

以下のコマンドを入力すると、、

phpcs --version

PHP_CodeSnifferをもう一度インストールする

pear install --alldeps PHP_CodeSniffer

PEARをアップグレード

pear upgrade-all

PHP_CodeSnifferのバージョンを確認

pear list

キャッシュをクリア

pear clear-cache

WordPress-Coding-Standards のインストール

https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards

一式をダウンロードして「C:\xampp\php\pear\PHP\CodeSniffer\Standards」にフォルダごと格納。

cd C:\xampp\phpで移動。

phpcs --config-set installed_paths C:\xampp\php\pear\PHP\CodeSniffer\Standards\WordPress-Coding-Standards

一瞬で「successfully」が表示されるはずです。

WordPressのコーディングルールが入っているか確認

phpcs -i

  • WordPress
  • WordPressCore
  • WordPressExtra
  • WordPressVIP

このあたりが入っていればOK。

使ってみる

調査したい対象のファイルの階層にcdで移動。

phpcs --standard=WordPress functions.php

問題のある箇所を一覧で表示してくれます。