「ちゃんとしたプラグイン開発ってどうやるの？」「おっきなプラグイン作ったらカオスった……」などの悩みを解決する方法をご存知だろうか？ WordPressプラグイン用の雛形とそのGeneratorを使えば、そんな悩みとは無縁な上、スタートダッシュを決められる。

 

WordPress Plugin Boilerplate (WPPB)

WordPress Plugin Boilerplate（＝WPPB）という、プラグインの雛形を提供しているオープンソースプロジェクトがこちら。WPPBから雛形をダウンロードし、自分の作るプラグインに合わせてプラグイン名などを置き換えて使う。

WordPress.orgによるPHPコード規約とドキュメント規約をこの雛形は守っているから、プラグイン作りで随時参考にすれば書き方としてはちゃんとした物が出来上がる。

WPPB自体はGithubで公開されている。

DevinVinson/WordPress-Plugin-Boilerplate

 

WordPress Plugin Boilerplate Generator

WPPBをカスタマイズし、プラグインに合わせて生成してくれるサービスがWordPress Plugin Boilerplate Generatorだ。

WPPBをベースにプラグインを作る際、プラグイン名や作者情報なんかは手動で置き換えないといけない。このサービスはそうした機械的に置換できるところを自動でやってくれる。う〜ん、至れり尽くせり。

 

余談 : YeomanからもWordPressプラグインが作れる

実はYeomanにもWordPressプラグイン用のGeneratorがある。

WebDevStudios/generator-plugin-wp

WPPBのGeneratorと同じくある程度自動でセットアップしてくれる。

 

WordPress Plugin Boilerplate Generatorの使い方

WordPress Plugin Boilerplate Generatorは簡単に使うことができる。

説明のために、WordPressにデフォルトで入っている無駄プラグイン『Hello Dolly』のジョブズ版を作ってみる。Hello Dollyは、ダッシュボードの右上にHello Dollyの歌詞の一部を表示するというだけの、Leave Me Alone Boxに毛が生えた程度に有用なプラグインだ。このプラグインをもじり、ジョブズの名言をダッシュボードに表示してみる。ヨダレを垂らしてプラグインを欲しがる意識高い系の姿が目に浮かぶ。

 

雛形の生成

まずはサービスにアクセスし、ページ中ほどのフォームにプラグイン名などを記入する。

すべてのフォームに記入し終わったら『BUILD』をクリックしよう。カスタマイズされた雛形をダウンロードできる。

 

オブジェクト指向でWordPressプラグイン作り

WPPBはWordPressプラグインをオブジェクト指向で作れるように設えられている。参考にするHello Dollyは一枚のPHPファイルにベタ書きしてあるから、これをWPPBの作りに合うようにわける。

どのように分けるか？Hello Dollyのソースを見てみると、『admin_notices』と『admin_head』にアクションフックをしかけている。前者は管理画面への歌詞の出力、後者は歌詞の見栄えを定めている。大きく見ると、フック登録と、呼び出されるロジックの２つの部分にわかれていることが分かった。

まずはフックの登録。管理画面系のフック登録はHello_Jobs::define_admin_hooks（class-hello-jobs.phpに記載）にまとめられているからここに移そう。

 

次に意識高い系垂涎のジョブズ名言を出力&スタイリングするロジックを移す。これは上記のフック登録で呼び出しているHello_Jobs_Admin内に記述する（class-hello-jobs-admin.php）

 

首尾よくいけば、管理画面からドラスティックでフレキシブルなインサイトがアウトプットされるだろう。

 

 

WordPress開発について一番新しい参考書はこちら