最近日本の方の WordPress プラグインもずいぶん増えてきて、同じことをしている人間としては嬉しい限りです。 🙂
ぼくも何本か書いてきて、ようやく勘所のようなものがつかめてきたのでちょっとプラグイン作成のノウハウなんかをエントリしてみたいと思います。
いや、最初のころはずいぶん苦労したんです。。 なにができなかったって、PHP を知らなかった。 最近だいぶ”ソラ”でかけるようになってきましたが、まだまだ語彙が少なく、できる方から見ればなんだこりゃ、なんだと思うんですが…。
でまぁ、知らなくてもノリでできちゃうのがスクリプト言語の良いところ。 ここでは、「管理画面のある WordPress プラグインの作成方法」を書いてみたいと思います。
管理画面の追加の方法は分かるとして、問題はデータの保存とプログラムの構造。 経験的に以下の構造にすると、ストレス無くコードをかけるような気がします。 まずはクラスを 3 つつくります。
- WordPress とインターフェースするクラス (ex. class WpHoge)
- データを処理するクラス (ex. class WpHogeModel)
- 管理画面の HTML を出力するクラス (ex. class WpHogeView)
プログラムの構造はいわゆる MVC の構造をとるわけですが、あんまり厳格にやると、一般的な WP のプラグインの規模くらいでは逆に面倒になりますのでその辺は適当に… 😛
class WpHoge は、WordPress とのインターフェースを書きます。 プラグインメインロジックと WordPress の仲介をするコントローラクラスですが、要は WordPress のコア関数を呼ぶのはなるべくここだけにします。(たとえば、多国語化すると WpHogeView に __、_e をかかなければならないのとかは愛敬。 WpHoge でラップしてもいいけど、そこまでは…）
今回書きたかったのは、以下から。 管理画面で設定するオプションデータの保存処理の方法のノウハウです。
class WpHogeModel には、メイン処理、いわゆるビジネスロジックを書きます。
データ保存をするときのポイントは、このオブジェクトの状態をそのまんま WP のデータベースに保存すること。 オブジェクトを復元すれば、次回同じ状態（設定したオプション値など）をうまく再現できるわけです。 では仮に WpHogeModel を以下のように定義します。
- class WpHogeModel {
-
- // メンバ変数
- $oprion = array();
-
- // コンストラクタ
- function WpHogeModel() {
- $option['保存したいオプション1'] = 初期値;
- $option['保存したいオプション2'] = 初期値;
- $option['保存したいオプション3'] = 初期値;
- }
-
- // 処理
- function syori() {
- $this->$option['保存したいオプション1'] = 更新値;
- }
-
- }
保存したいオプション値をメンバ変数にして、オブジェクトを new した時唯一実行されるコンストラクタには、保存したいオプション値の初期値を書いておきます。 で、あとはオプションのメンバにアクセスしつつ適当に処理を書きます。
次に WP の領域でインスタンス化するコントローラ class WpHoge の中で、この class WpHogeModel のインスタンスをつくります。
でもって、インスタンス化した class WpHogeModel を”ごっそり”シリアライズして WP に登録してしまいます。（初回） もし、すでに WP に登録があるようであれば、シリアライズされたデータからインスタンスを復元します。（２回目以降）
２回目以降インスタンスの復元時は、new されるわけではないので class WpHogeModel のコンストラクタは働かず、オプションは初期化されずオプションのメンバ変数が WP に登録された時点のものに復元されるわけです。 あとは、また通常通り Model の処理関数をコントローラから呼び出して処理を続行するだけです。
class WpHoge のデータ取得系の処理はたとえば以下のようになるでしょう。
- class WpHoge {
-
- var $model;
-
- // コンストラクタ
- function WpHoge() {
-
- $this->model = $this->getModelObject();
- $this->model->syori();
-
- }
-
- // モデルオブジェクトの作成
- function getModelObject() {
-
- // WP からオプション所得
- $option = $this->getWpOption();
-
- // Model のクラスが登録されていたらそれを復元
- if(strtolower(get_class($option)) == strtolower('WpHoge')) {
- $model = $option;
- }
- // なかったら(初回) 新しく Model インスタンスつくって WP に登録(writeWpOptionは省略)
- else {
- $model = new WpHoge();
- $this->writeWpOption($model);
- }
-
- return $model;
-
- }
-
- function getWpOption() {
-
- $option = get_option('オプション登録名');
-
- if(!$option == false) {
- $OptionValue = $option;
- } else {
- $OptionValue = false;
- }
-
- return $OptionValue;
-
- }
-
- }
あとは、管理画面からの更新などをきっかけとして、コントローラが Model をコントロールしつつ適切なタイミングで WP に add_option、update_option すれば OK です。 これらの関数はオブジェクトが引数に渡されると勝手にシリアライズしてくれます。
この方式をつかうと、オプションの保存/取得が 1 query になりますし、なにより “楽” です。 wp-kumonosu がこの方式で動いていますので、興味がある方はコードをみてみてください。
wp-kumonosu では管理画面からの http リクエストをコントローラで Model に振り分け処理を進めていっています。 Model で直接 WordPress の DB に SQL 発行しちゃったりして、厳密に言うとちゃんと MVC になっていないのですが、まぁひとりで作るくらいの規模なのでいいんじゃないっすか 😛
みなさんそれぞれのコーディングスタイルがあると思うので、これがいいってわけでもないのですが、もし管理画面付きプラグインでコードが煩雑になって困っている方のご参考になったら。
Moon:9.8[十日月]
Moon:7.3[弓張月（上弦）]
ひろまさ @ 12:36 
Moon:5.7[六日月]
ひろまさ @ 22:00 
Moon:1.6[二日月]
ひろまさ @ 19:07 
(0/-4) ひろまさ @ 3:53 
Moon:25.2[二十六夜]
Moon:24.4[二十五日月]
ひろまさ @ 23:29 
Moon:21.6[二十二日月]
Moon:17.5[居待月]
