ボイラープレートの活用

ボイラープレート (boilerplate) とは?

プログラミングの文脈では、よく書くコードを予め記述しておいたファイル群のことです。
言い換えると テンプレート と考えて良いでしょう。ボイラープレートを利用することで、記述する量を抑え、一定の品質を備えたプラグインを素早く作ることができます。

なぜボイラープレートを利用するのか?

WordPrssのプラグインを作るには、以下のような一定のコーディングルールがあります。

  • プラグイン名の指定
  • プラグインスラッグの指定
  • 翻訳のためのテキストドメインの指定
  • バージョンの指定
  • 管理画面用コードのファイルレイアウト
  • フロント用コードのファイルレイアウト
  • js/cssの読み込み
  • プラグインのインストール/有効化/無効化/アンインストール処理
  • ライセンスの記述
  • REAME.txtの記述

プラグインをいくつも作るようになってくると、これらをいちいち作るのが面倒になってきます。
なので、ボイラープレートを利用して、時間短縮を図る狙いがあります。


WPプラグインのボイラープレートを作る

外部サイトで生成してダウンロードする場合:

以下のサイトでボイラープレートを生成してダウンロードすることができます。私がよく使うサイトはこちらです:
WordPress Plugin Boilerplate Generator | Ready to use WordPress Plugin Boilerplate

boilerplate-1

WP-CLI で生成する場合:

WP-CLI の wp scaffold コマンドを使うことでもプラグインのテンプレートを生成することができます。

WP-CLIの場合は、 PHPUnitによる単体テストを意識したファイルレイアウトになりますが、
その他は必要最低限のファイルのみが生成されます。


ボイラープレートの概要

ファイルレイアウト

wppb.me でダウンロードしたボイラープレートのファイルレイアウトはこのようになっています。

最初はとっつきにくいかもしれませんが、慣れれば どこにコードを配置すればよいかを考え込む必要がなくなるので便利です。

Filed under: プラグインTagged with:

No comment yet, add your voice below!


Add a Comment

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください