WordPress のビジュアルリッチエディター（tinyMCE）に独自のボタンを追加する機会が多いので、それを容易にするためのクラスをつくった。

このクラスは WordPress プラグインではなく、WordPress プラグインを制作するときに使用するためのクラスです。

目的

WordPress のビジュアルリッチエディターでは、tinyMCE というJavaScript のライブラリを使用しているが、本家の tinyMCE では WordPress に実装されている機能よりはるかに多くの機能がプラグインとして配布されている。

これらの全てを実装することは、サポートや使い勝手の面でベターとは思わないが、いくつかの機能を追加したいと感じることは多い。

そこで、これらの tinyMCE プラグインを追加しやすくするためのクラスをつくった。

仕様

WordPress の tinyMCE にプラグインを追加するには、WordPress 側のプラグインで以下のアクションフィルターを使用する。

• mce_external_plugins
• mce_external_languages
• tiny_mce_before_init
• mce_buttons

このクラスでは、最大５つのパラメータをコンストラクタの引数に渡すことで、これらのアクションフィルターを定義する。

ダウンロード

最新版のソース

使い方

以下のような感じで使用する。

1. WordPress プラグインを作成するためのPHPファイル、ディレクトリを作成する。
2. プラグインディレクトリ内に任意のtinyMCEプラグインを設置する。
3. WordPress プラグイン側で後述のように、コンストラクタを起動する。

コンストラクタ

new mcePlugins(......)

引数には以下の項目を設定する。

1. $plugin_name : プラグインの名前
2. $plugin_url : tinyMCE プラグインのeditor_plugin.js までのURL
3. $lang_path : 言語ファイルまでのパス
4. $button_callback : tinyMCEにボタンを追加するためのコールバック関数
5. $inits : tinyMCE の動作設定を行うための配列

上記の個々の項目の詳細については、ご自身で調べまくってください。

このサイト上でも、今後、すこしずつご紹介していきます。