技術資料

Movable Type のプラグインの作り方の解説記事、第一回です。

まずは、Movable Type管理画面のプラグイン一覧に表示されるだけのプラグインを「SamplePlugin」という名前で作ってみます。

プラグインディレクトリの準備

mt/plugins/ のディレクトリ内に、SamplePlugin/ ディレクトリを作成します。

プラグインディレクトリの構造

プラグインのディレクトリ構造は以下のような感じになります。

mt/plugins/SamplePlugin/
├─ config.yaml
├─ lib/
│   └─ SamplePlugin/
│       └─ Plugin.pm
└─ tmpl/
    └─ config.tmpl

必要に応じて、lib/ ディレクトリや tmpl/ ディレクトリを作成し、プラグインのロジックやテンプレートファイルを配置します(今回は割愛)。

プラグインの設定ファイルを作成

SamplePlugin/ ディレクトリ内に、config.yaml ファイルを作成します。

config.yaml の内容は以下の通り。

id: SamplePlugin
name: SamplePlugin
version: 0.1
description: 一覧画面に表示されるだけのプラグインです。
author_name: Tatsuya Abe
author_link: https://www.abe-tatsuya.com/
doc_link: https://www.abe-tatsuya.com/document_url/

config.yaml の各フィールドの説明

config.yaml ファイルの各フィールドの意味は以下の通りです。

id

プラグインの一意の識別子

name

プラグインの表示名

version

プラグインのバージョン

description

プラグインの説明文

author_name

プラグインの作者名

author_link

作者のウェブサイトのリンク

doc_link

プラグインのドキュメントへのリンク

動作確認

Movable Type の管理画面にログインし、「システム」⇒「設定」⇒「プラグイン」を開いて、インストールされているプラグインの一覧を確認します。

「SamplePlugin」が一覧に表示されていれば、プラグインの設定ファイルが正しく設定されていることになります。

トラブルシューティング

プラグインが正しく表示されない場合は、以下の点を確認してください。

• config.yaml ファイルの記述に誤りがないか
• プラグインのディレクトリ構造が正しいか
• Movable Type のキャッシュをクリアして再度確認する