MODXのプラグインの使い方

MODX のプラグインの使い方を説明します。

イベント時に実行されるプログラムです。

例えば、表示するドキュメントを取得したとき、ドキュメントを表示するとき、ドキュメントを編集したとき、など特定のタイミングで実行されます。「MODX Evolution 1.0.6J-r8」現在の時点で、112個のイベントがあります。

新しいプラグインを追加する

配布されているプラグインを追加する基本的な流れとしては、ダウンロードして圧縮ファイルの中にある assets または plugins フォルダをそのまま assets 以下にコピーし、*.ptl というファイルの内容を新規プラグイン作成画面の「プラグイン コード (php)」にコピペするだけです。

ここでは KCFinder という、ファイルブラウザ用のプラグインをインストールする手順で説明します。

http://modx.jp/download/extras/plugins/kcfinder.html

上記のページの「kcfinder_251.zip」(2012.10.29現在)をダウンロードします。

assets または plugins フォルダがある場合は、そのまま assets フォルダにコピーします。
以下のような感じになります。

/assets/
├/plugins/
│└/kcfinder/
│ ├/kcfinder/
│ ├fb.js
│ └functions.php
├/snippets/

次に、エレメント>プラグインタブからプラグインの作成ページを開きます。
kcfinder.tpl をエディタで開いて内容をそのままプラグインコードにコピペします。

プラグインのヘッダーが自動認識フォーマットになっていれば、プラグイン名、設定、システムイベントの登録などは自動的に行われます。もしそうでない場合は配布先に設定方法が書いてあるかと思うのでそれに従って設定してください。

とりあえずこれでプラグイン自体のインストールは完了です。実際にファイルブラウザを開いた時に KCFinder が選択されるようにするには、TinyMCE 側の設定も必要です。こちらを御覧ください。

既存のプラグインをアップデートする

基本的には新規作成と同じ手順です。
フォルダを assets 内にコピーして、*.tpl をコピペする時は新規のプラグインではなくて更新したいプラグインのページを開きプラグインコード部分に上書きコピペするようにします。この時プラグイン固有の設定は初期化される為なにか設定をしているなら再設定が必要になります。

Edited on 2017.04.10 Created on 2012.10.28 MODX