Appearance
PHPCS実行ガイド
- プロジェクトでPHPCS(PHP CodeSniffer)によりコーディング規約をチェックする方法。
- WordPress Coding Standards をベースに一部ルールを調整しています。
- 実行コマンドは コマンド一覧 を参照してください。
環境セットアップ
- 前提: PHP 8.3以上、Composer
- インストール: プロジェクトルートで
composer installを実行(PHPCS と WPCS が入ります)
設定の概要(config/phpcs.xml)
対象・除外
| 種別 | 内容 | 説明 |
|---|---|---|
| 対象 <file> | connector.php, core_src, config | チェック対象のファイル・ディレクトリ |
| 除外 <exclude-pattern> | */vendor/*, */node_modules/*, */_build/*, */tests/*, *Test.php, *.js, *.css など | マッチしたパスはチェック対象外 |
ルール構成
| ルール | 説明 |
|---|---|
| WordPress(ベース) | <rule ref="WordPress"> を採用し、以下を除外して調整 |
| → ファイル名 | WordPress.Files.FileName を除外(ファイル名の厳格な制約を緩和) |
| → ドキュメント | VariableComment.Missing のみ除外(プロパティは段階的改善)。FileComment・ClassComment・FunctionComment.Missing は適用。 |
| → 配列・構文 | 短縮配列・三項演算子・配列スペース等の WordPress 側ルールを除外(後述の追加ルールで統一) |
| → 変数名 | ValidVariableName(スネーク_case)を除外し、camelCase を許可 |
| → セキュリティ | ValidatedSanitizedInput の Unslash/InputNotSanitized を除外(開発環境用に一部緩和) |
| → コメント句読点 | インライン・Param・Throws・DocComment の「ピリオド必須」を除外(日本語コメント向け) |
| Slevomat UnusedUses | 未使用の use 文を検出(searchAnnotations: true) |
| Generic DisallowLongArraySyntax | array() を禁止し [] を強制 |
| Generic ForbiddenFunctions | eval, exec, passthru, shell_exec, system を禁止。curl_exec は wp_remote_request を推奨 |
| WordPress.DB.PreparedSQL | SQL のプリペアをチェック(NotPrepared の誤検知は除外) |
実行オプション・その他
| 設定 | 値 | 説明 |
|---|---|---|
| severity | 1 | 重要度1以上を報告 |
| tab-width | 4 | タブ幅(表示用) |
| cache | .phpcs-cache | キャッシュディレクトリ |
| parallel | 1 | 並列数 |
| colors | 有効 | 出力を色付きに |
| extensions | php | PHP のみチェック |
| memory_limit (ini) | 512M | PHP のメモリ上限 |
詳細は config/phpcs.xml を参照してください。
最終更新: 2026-02-20