hiromasa.zone : o)

WordPress プラグイン作成時のノウハウ – 後編 – です。

前回はこちら、

WordPress プラグイン作成のノウハウ – 中編 –

いろいろ書いてしまいましたが、実は「中編」の知識だけで WP プラグインは書くことは可能です。　あとは hook のドキュメントを見て、”おお、こんなところに割り込めるのか。これを使えば、、ふふふ。” と思う気持ちが芽生えればもうプラグインマスターです。

たとえば、the_content というフィルター hook はエントリの本文を全て渡してきてくれるので、渡された本文の文字列の単語や語尾を置換し、札幌弁や岡山弁や博多弁（地域の選択に深い意味はございません(?)…）に変換してしまうプラグインの機構なんてのは、すぐつくれることでしょう。 😛

機構ができれば、あとはこの “置換する” といった部分を hook に登録した関数に、”機械の言葉” = ソースコードで書けば OK です。なにやら難しそうな雰囲気ですが、そこはそこ我らが PHP。これ以上ないくらい便利な関数が沢山用意されていますので、たとえば Google で “PHP 置換” なんてやりたいことを検索すれば参考になるサンプルソースがたくさん出てくることでしょう。あとは、プラグインとして機能するようにそのソースをあてはめれば良く、もしかすると PHP 知らなくてもプラグインかけちゃうかもしれません。 🙂

とりあえず前回の、「投稿時間に “☆” を無意味に付けるプラグイン」を有効化して 登録する hook や関数の中を書き換えていけば自然と概略が分かってくると思いますので、興味のある方は是非どうぞ!

さてさて、このようにして作っていったプラグイン。実はソース（機能）が大きくなっていくとちょっとした壁にあたります。

• 作成した関数”名”が WordPress 本体や他のプラグインとかぶるんじゃないかと不安になってくる
• 関数間で使い回したい変数や定数があるときに、グローバル変数や define を使わなくてはならず、これまた名前の重複が不安になる
• 上記理由でグローバル変数を使いたくないから関数内で定数を定義すると、hook で呼ばれるたびに初期化しなくてはいけなくて何か釈然としない

ふまえて前回作った「投稿時間に “☆” を無意味に付けるプラグイン」をみてみます。

この場合、

• 関数名 startime が他と重複してはいけない
• $hosi 変数（定数）を hook が呼ばれるたびに再定義している

ということになります。（え、$hosi は強引じゃないかって･･･、その通りです。orz　サンプルということでお許しを…）

これを解決するのに PHP で用意されているオブジェクト指向用の記述(class)を使ってみます。

ソースを見たほうが早いので、同プラグインを class 化したソースをまず書きます。

☆を出力する関数の定義部分(addStar)が class StarTime の中に入ったのが分かります。また、class の StarTime() 関数が新設され $hosi の “初期化” を行っています。

ではソースを上から見ていきます。とりあえずコメントはいいとして、hook の登録の部分が変りました。

まず、class StarTime のオブジェクトの作成(15行目)をしているのが分かります。次に、add_filter でそのインスタンスと hook したときに呼ばれる関数名(addStar)を登録しています(17行目)。インスタンスの関数を hook に登録するときはこのように array 形式で記述を使います。（なお $startime 変数の前に “&” を付けているのは PHP 4系互換のためです。5系ではデフォルト参照で渡るので必要ありません。）

記述方法が変っただけでやっていることは同じですね!

次に class の定義部分をみていきます。

24行目でメンバ変数として（ここでは）定数となる変数 $hosi を定義しています。

そして、26行目からの StarTime() がこのオブジェクトのコンストラクタです。　class 名と同じ名称の関数がコンストラクタになります。コンストラクタが呼び出されるタイミングは、オブジェクトが作成された時･･･ 15行目で「$startime = & new StarTime();」された時になります。　つまり、プラグイン内で一度だけでいい “初期設定”を行うタイミングをつくることができました。　ここでは、$hosi を “☆” に設定することでプラグインの生存期間は自由にこの変数を使えるということになります。

このように class 化することでまずは、

関数間で使い回したい変数や定数があるときに、グローバル変数や define を使わなくてはならず、これまた名前の重複が不安になる

上記理由でグローバル変数を使いたくないから関数内で定数を定義すると、hook で呼ばれるたびに初期化しなくてはいけなくて何か釈然としない

という問題点が解決できるわけです。

コードを再び追っていきます。

addStar 関数が hook から呼ばれる関数です。この関数”名”は StarTime クラス内でしか通用しない名前になります。 class 内であればいくつでも関数をつくって大丈夫です。　class 内でのみ有効な名前です。

ということで、

作成した関数”名”が WordPress 本体や他のプラグインとかぶるんじゃないかと不安になってくる

この問題も class 化することで解決することが出来ます。

もちろん WP とインターフェースしている以上、この “名称かぶり” の問題は依然として残っていて、気をつけなければならないのは、

の、class 名(StarTime) とインスタンス変数($startime) 名がかぶってはいけない名前です。まぁこればかりは WP とプラグインが繋がっている以上しょうがない部分ですので気をつけて名称を決めましょう。 🙂

以上まとめますと、大きめのプラグインは class 化すると、

• コンストラクタ部分にプラグインの初期化コードを設けることが出来る
• class を名前空間として使い他のプログラムとの関数/変数名の重複を考えなくて済むようになる

ということが出来るようになり、大分プログラムが書きやすくなります。

お気づきの方も多いと思いますが、今回サンプルにした Class 版とClass 版じゃない StarTime、実は名称のかぶりを気をつけるという観点だと、Class 版 “じゃないほう”が気をつける個数的に勝っています･･･、これを改悪と呼ぶ。。　サンプルは関数一個の小さいものですので、こういった場合には無理に class 化する必要はないということですね。　また、変数の初期化も強引なものでした。

では最後に、本当は今回のサンプルにするはずだった「wp-hatena」のソースのメイン部分を class 化したプラグインの例として記載します。　プログラム中、未完成でコメントアウトしている部分があるのですが、とりあえずあるものとしてみてください。

次回はようやく wp-hatena を使ったソースの細かい説明と、「del.icio.us」対応、そして Masayan さんからいただいた不具合報告(!)の対応をしてみたいと思います。

･･･え、後編なのにまだ続くのって･･･。　はい。。　続編に続く･･･。

[続き..]

wp-hatena にみるプラグインの作成方 – 第１章 –