Wordpress プラグインの作り方(1)

皆さん、Wordpress 使ってますか？2.6 がリリースされ、gears 対応となりましたが・・・それはさておき Wordpress にはプラグインと言う機能追加のためのインターフェースが用意されています。

そんなプラグインですが、イチから作り方の書いてある日本語記事は少なく、「Wordpress を使ってはいるけれど、プラグインは誰かが作ったものを探しているか、見つからなければあきらめている。作り方など知ってるわけないでしょ？ばかなの？しぬの？」という方も割合多いのではないでしょうか。
と言うわけで、今回からしばらく Wordpress プラグインの作り方を連載していきます。
こんな感じで。

1. Wordpress プラグインの動作原理
2. プラグインをクラスにまとめる
3. 翻訳の原理
4. 管理画面の設定に設定画面を追加
5. 設定内容をデータベースに保存
6. どのタイミングでなにが呼ばれるのか

今回は1回目ですので「Wordpress プラグインの動作原理」についてお話します。

アクションとフィルタ

Wordpress には”アクション”と”フィルタ”と言う二つの機能があります。
アクションとは、決められたタイミングに関数やメソッドを実行させるためのインターフェースです。
フィルタもアクションと同様の動作をしますが、アクションとは違い、フィルタの元となる関数やメソッドの返り値をフィルタリングするための値をして受け取って処理します。
Wordpress から見るとアクションもフィルタも任意の関数やメソッドが、フックした関数やメソッドを関数やメソッド内の任意のタイミングで実行させているに過ぎません。
出力する内容を編集(フィルタリング)したいならフィルタ、そうでないならアクション、と言う程度のアバウトな感覚でよいと思います。

フックさせるには

フックとは横から殴るわけではなく、あるトリガに対して関数やメソッドを引っ掛ける(フック)事を言います。
フックした関数やメソッドは、フックされた関数やメソッドが実行されるタイミングで実行される事となります。
アクションもフィルタも Wordpress 本体(以下: wp コア)の随所にトリガとなる場所があります。しかも、トリガとなる場所は任意で増やすことが出来てしまいます。
このトリガと実際に実行される関数やメソッドをフックするために、wp コアでは二つの関数が提供されています。

アクションの場合「ここがトリガですよ」を表すのは do_action()、「○○トリガを通過したらこれを実行して(フック)」を表すのは add_action() です。
例えば Wordpress のデフォルトテーマの footer.php には wp_footer() と言う関数が書かれていますね。
この wp_footer() をトリガにして hogehoge() を実行させたい！と思ったならば以下のように記述します。

<?php
add_action( 'wp_footer', 'hogehoge' );
?>

これだけで wp_footer() が実行されるときに hogehoge() も実行されるわけです。
ちなみに add_action() は call_user_func() をラップしているのでインスタンスのメソッドや静的なクラスのメソッドを指定する事も可能です。
僕は global 空間に関数を増やしたくないのでいつも静的なクラスのメソッドを呼び出しています。
オブジェクトを複数生成する必要性がないのでインスタンスも作りません。
その場合は

<?php
add_action( 'wp_footer', array( 'hogehoge', 'hugahuga' ) );
?>

と書くことで hugahuga::hogehoge() が呼び出されます。

プラグインの動作原理

このように任意の場所に置かれたトリガに対して任意の関数やメソッドをフックさせるのがプラグインの基本的な動作原理となります。
設定画面にプラグイン用の設定ページを追加するのもアクションで行います。
要するに最低限アクションとフィルタさえ理解していればプラグインは作れるわけです。

フィルタの実践

実際に簡単なプログラムをトリガにフックさせてみましょう。
記事本文に含まれるアンカータグの href 属性を記事末尾にリストとして表示させてみます。
アクションもフィルタと大差なく、トリガが置かれている関数から値が渡されるか渡されないかの違いだけです。

<?php
class links {
    public static function display( $arg ){
        echo $arg;
        if( !preg_match_all( "/href=\"([^\"]+)\"/iu", $arg, $matches ) ) return;
        $links = array( '<h4>Links</h4>', '<ul>' );
        foreach( $matches[1] as $href ) $links[] = "\t<li>{$href}</li>";
        $links[] = '</ul>';
        echo implode( "\n", $links );
    }
}
add_filter( 'the_content', array( 'links', 'display' ) );
?>

links::display() は the_content() の返り値(記事本文)を受け取り、受け取った値の中に含まれる全ての href 属性を探します。
見つからなかった場合は the_content() から渡された値だけを表示するにとどまりますが、もしひとつでも href 属性が見つかった場合はその URI をリストとして記事末尾に追加します。
上記のソースをテーマの index.php の一番上に貼り付けてみて下さい。
記事の末尾に Links と共に URI がリスト表示されれば成功です。

ね、簡単でしょう？