• Home
  • Craft CMS
  • Craft CMS の独自プラグインを作成する - STEP 1 雛形を作成

Craft CMS の独自プラグインを作成する - STEP 1 雛形を作成

今日から数回に渡って、Craft CMS の独自プラグインを作って行きたいと思います。BUN さんが Craft CMS のプラグインを作ってみよう | BUN:Log ですでに同様の記事を書いてくれていますのでそちらも参考に。

プラグインの概要

今回は、特定のセクションのエントリを投稿すると Slack に通知が飛ぶプラグインを作っていきたいと思います。

開発環境

今回の実装は、Craft Nitro を使った Craft CMS 用ローカル環境の作り方 で構築した Craft の開発環境「Nitro」の Craft 3.5 系ベースに作ります。

プラグインの雛形を作成

まずはプラグインの雛形を作成します。Craft CMS のプラグインの雛形は、Build to Order Craft CMS plugins | pluginfactory.io で作成するのが便利です。

pluginfactory.io で、下記のように情報を入れて雛形を作成します。

Screencapture pluginfactory io 2020 12 06 12 50 51
API Version: Craft CMS Plugin version 3.x
Plugin Name: Post to your Slack
Description: 特定のセクションを保存したら Slack に通知を飛ばします。
Initial Version: 1.0.0
Plugin Vendor: ご自分の composer のベンダー名(例)somevendor\someplugin
Author: ご自分のお名前
Author URL: ご自分のブログやウェブサイトのURL
GitHub Name: ご自分の Github 名

ページ下部の選択する項目は下記のとおり通りです。下記にない項目は OFF のままで OK です。

  • Tweet it out: OFF
  • Code Comments: ON
  • Services: ON (Name: 空欄のまま)
  • Tests: OFF

設定(入力)が終わったら「BUILD MY PLUGIN」をクリックしてファイルをダウンロードします。

これでひな形は完成です。

次回は、このプラグインを Craft にインストールしてみましょう。