ステップ・バイ・ステップで Craft CMS の独自プラグインの作成方法をご紹介します。ステップ2では前回作成したプラグインの雛形をインストールする方法をご紹介します。
ステップ・バイ・ステップで解説する Craft CMS の独自プラグインの作り方、今回は前回「Craft CMS の独自プラグインを作成する - STEP 1 雛形を作成」で作成したプラグインの雛形を、Craft CMS にインストールする方法をご紹介します。
前回の例では「Post to your Slack
」というプラグインを作成したので、それを前提に話を進めますので、必要に応じて読み替えてください。
まずは「Craft Nitro を使った Craft CMS 用ローカル環境の作り方」にそって Craft CMS をインストールしてください。もし開発用の Craft 3 があればそれを使っていただいて構いません。
Craft CMS のプロジェクトディレクトリ(Craft CMS がインストールされている、config
や templates
ディレクトリと同じ階層)に plugins
というディレクトリを作成し、その中に前回作成したプラグインを設置します。
続いて、composer.json
に下記のように repositories
セクションを追加します。
"repositories": {
"tinybeans/post-to-your-slack": {
"type": "path",
"url": "plugins/posttoyourslack"
}
},
tinybeans/post-to-your-slack
のところは、作成したプラグインの中にある composer.json
に書いてある name
部分になります。
"url": "plugins/posttoyourslack"
のところは、先程設置したディレクトリ名になります。
次に SSH でサーバーに入り、Craft CMS のプロジェクトディレクトリに移動します。Craft Nitro で作成した環境の場合は、ターミナルでコンピュータ内のそのディレクトリに行けばOKです。
ディレクトリに移動したら下記のように composer require
コマンドを叩きます。僕の環境では下記のようになります。
% cd ~/Projects/Nitro/craft-nitro
% composer require tinybeans/post-to-your-slack
最後に Craft のプロジェクトディレクトリで craft plugin/install <plugin handle>
コマンドを使ってインストールします。<plugin handle>
部分は、上記の composer require
したときのベンダー名ではない方を入れます。今回の例で言えば下記のようになります。
% ./craft plugin/install post-to-your-slack
*** installing post-to-your-slack
*** installed post-to-your-slack successfully (time: 0.034s)
もし上記のコマンドでうまく行かなければ、管理画面からインストールすることも可能です。
管理画面の「設定 > プラグイン」に移動して「Post to your Slack」プラグインの右にあるメニューで「インストール」をクリックすればインストール完了です。
次回からコードを書いてプラグインの機能を実装していきたいと思います。