Contents
ボイラープレート (boilerplate) とは？
プログラミングの文脈では、よく書くコードを予め記述しておいたファイル群のことです。
言い換えると テンプレート と考えて良いでしょう。ボイラープレートを利用することで、記述する量を抑え、一定の品質を備えたプラグインを素早く作ることができます。
なぜボイラープレートを利用するのか？
WordPrssのプラグインを作るには、以下のような一定のコーディングルールがあります。
- プラグイン名の指定
- プラグインスラッグの指定
- 翻訳のためのテキストドメインの指定
- バージョンの指定
- 管理画面用コードのファイルレイアウト
- フロント用コードのファイルレイアウト
- js/cssの読み込み
- プラグインのインストール/有効化/無効化/アンインストール処理
- ライセンスの記述
- REAME.txtの記述
プラグインをいくつも作るようになってくると、これらをいちいち作るのが面倒になってきます。
なので、ボイラープレートを利用して、時間短縮を図る狙いがあります。
WPプラグインのボイラープレートを作る
外部サイトで生成してダウンロードする場合:
以下のサイトでボイラープレートを生成してダウンロードすることができます。私がよく使うサイトはこちらです:
WordPress Plugin Boilerplate Generator | Ready to use WordPress Plugin Boilerplate
WP-CLI で生成する場合:
WP-CLI の wp scaffold コマンドを使うことでもプラグインのテンプレートを生成することができます。
|
1 2 3 4 5 |
wp scaffold plugin <slug> [--dir=<dirname>] [--plugin_name=<title>] [--plugin_description=<description>] [--plugin_author=<author>] [--plugin_author_uri=<url>] [--plugin_uri=<url>] [--skip-tests] [--ci=<provider>] [--activate] [--activate-network] [--force] |
WP-CLIの場合は、 PHPUnitによる単体テストを意識したファイルレイアウトになりますが、
その他は必要最低限のファイルのみが生成されます。
ボイラープレートの概要
ファイルレイアウト
wppb.me でダウンロードしたボイラープレートのファイルレイアウトはこのようになっています。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
$ tree wpwand-plugin-1 wpwand-plugin-1 ├── LICENSE.txt ├── README.txt ├── admin │ ├── class-wpwand-plugin-1-admin.php │ ├── css │ │ └── wpwand-plugin-1-admin.css │ ├── index.php │ ├── js │ │ └── wpwand-plugin-1-admin.js │ └── partials │ └── wpwand-plugin-1-admin-display.php ├── includes │ ├── class-wpwand-plugin-1-activator.php │ ├── class-wpwand-plugin-1-deactivator.php │ ├── class-wpwand-plugin-1-i18n.php │ ├── class-wpwand-plugin-1-loader.php │ ├── class-wpwand-plugin-1.php │ └── index.php ├── index.php ├── languages │ └── wpwand-plugin-1.pot ├── public │ ├── class-wpwand-plugin-1-public.php │ ├── css │ │ └── wpwand-plugin-1-public.css │ ├── index.php │ ├── js │ │ └── wpwand-plugin-1-public.js │ └── partials │ └── wpwand-plugin-1-public-display.php ├── uninstall.php └── wpwand-plugin-1.php |
最初はとっつきにくいかもしれませんが、慣れれば どこにコードを配置すればよいかを考え込む必要がなくなるので便利です。
No comment yet, add your voice below!