WordPress | コーディング規約

自作したプラグインの PHP コードが WordPress のコーディング規約に従っているか確認するために phpcs の拡張を行う。

phpcs をインストールする

最新の phpcd をダウンロードし、実行権限を付与して、パスの通ったディレクトリーに移動する。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
$ wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
--2020-12-16 21:12:30-- https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
Resolving squizlabs.github.io (squizlabs.github.io)... 185.199.108.153, 185.199.110.153, 185.199.109.153, ...
Connecting to squizlabs.github.io (squizlabs.github.io)|185.199.108.153|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 1286761 (1.2M) [application/octet-stream]
Saving to: ‘phpcs.phar’

phpcs.phar 100%[=================================================>] 1.23M 1.12MB/s in 1.1s

2020-12-16 21:12:34 (1.12 MB/s) - ‘phpcs.phar’ saved [1286761/1286761]

$ chmod +x phpcs.phar
$ sudo mv phpcs.phar /usr/local/bin/phpcs

現在利用できるコーディング規約を確認する

php -i コマンドを実行して、現在利用できるコーディング規約を確認する。

1
2
$ phpcs -i
The installed coding standards are MySource, PEAR, PSR1, PSR12, PSR2, Squiz and Zend

WordPress のコーディング規約を登録する

GitHub からWordPress のコーディング規約をダウンロードし、phpcs の規約として組み込む。

1
2
3
4
5
6
7
8
9
10
11
12
13
$  git clone -b master https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git  ~/.phpcs/WordPrees
Cloning into '/home/ken/.phpcs/WordPrees'...
remote: Enumerating objects: 129, done.
remote: Counting objects: 100% (129/129), done.
remote: Compressing objects: 100% (77/77), done.
remote: Total 17874 (delta 73), reused 97 (delta 46), pack-reused 17745
Receiving objects: 100% (17874/17874), 4.27 MiB | 489.00 KiB/s, done.
Resolving deltas: 100% (12550/12550), done.
Checking connectivity... done.
$ sudo phpcs --config-set installed_paths ~/.phpcs/WordPrees/WordPress
Using config file: /usr/local/bin/CodeSniffer.conf

Config value "installed_paths" added successfully

WordPress のコーディング規約が登録されたことを確認する

再度 phpcd -i コマンドを実行してコーディング規約が登録されていることを確認する。

1
2
$ phpcs -i
The installed coding standards are MySource, PEAR, PSR1, PSR12, PSR2, Squiz, Zend and WordPress