baserCMSで初めてプラグインを作ってみる時の基本知識
いつもお世話になっているbaserCMS。
ある程度baserCMSで、テーマのカスタマイズも経験し、プラグイン開発に挑戦してみようかな、と思っている人向けの記事です。
テーマの作成はある程度慣れてきたのだけど、まだまだ発展途上のbaserCMS。この機能があったらいいな、ということが多々あると思います。そんな時baserCMSは、CakePHPを利用して作られているので、普段からCakePHPを使っている方や、PHPのフレームワークに慣れている方は、簡単にカスタマイズしているという人もいらっしゃると思います。そこで、baesrCMSのプラグインとして作っておけば、別のプロジェクトで再利用することができますし、他のユーザーさんへ配布することも可能です。
baserCMSには、本体インストールと同時に3つのプラグインが最初からインストールされています。管理画面のプラグイン一覧を表示すると分かりますね。
それでは、baser/app/plugins/ の中に、myplugin というディレクトリを作ってみましょう。
myplugin ディレクトリを作ったら、プラグイン一覧をリロードしてみます。
プラグインとして認識され、プラグイン一覧に表示されました。
インストールボタンをクリックして登録すると、myplugin プラグインのインストール完了です。
空っぽのプラグインなので、インストールしても何も変化はありませんが、立派にプラグインとして、baserCMSのデータベースに登録されます。これでプラグインを開発するスペースを確保することができました。
プラグインのアップデートに重要なバージョン管理。VERSION.txt を作成し、バージョン番号を入力します。
myplugin/VERSION.txt
バージョン番号は、VERSION.txt ファイルの１行目に記述します。baserCMSでは、３区切りまでのバージョン番号を認識します。
(メジャーバージョン).(マイナーバージョン).(パッチ)
の順番で記述します。プラグイン一覧をリロードしてみましょう。前回インストール時のバージョンと違っていると、baserCMSが自動で判断して、
アップデートボタンを表示してくれます。
アップデートすると、プラグイン一覧の myplugin に、バージョンが表示されましたね！
インストール画面で利用する設定ファイル config.php を作成します。
myplugin/config/config.php
設定ファイルには、以下の設定を記述することができます。
$title = '{プラグイン名（日本語可）}';
$description = '{プラグインの説明文}';
$adminLink = '{管理画面用初期ページへのリンク}';
$installMessage = '{インストール画面に表示するメッセージ}';
$author = '{プラグインの作成者名}';
$url = '{プラグイン作成者のホームページURL}';
プラグイン一覧を確認してみると、「プラグイン名」「説明」「開発者＆リンク」の情報が設定ファイルから反映されていることが分かります。
$adminLink = '{管理画面用初期ページへのリンク}';
これを記述しておくだけで、プラグイン一覧に、
管理画面へのリンクボタンを表示してくれます。管理画面を操作するプラグインを作るときは、記述しておくと便利ですね！
