Wordpress に web API インターフェースを追加するプラグイン

Wordpress に web API インターフェースを追加するプラグインです。
最近良くある JavaScript なんかで任意の URL にリクエストを送って JSON とかでデータを返してくるアレです。
アレを Wordpress に追加するプラグインです。
jQuery なんかを使ってメディアライブラリに投稿した画像を表示するスライドショーとか、ページ遷移せずに検索結果を表示したいとか、既存のプラグインにこの API インターフェースを追加する事も可能ですので、使い方次第で色々と出来ると思います。

構造的な話

このプラグインは使い方によっては大きな穴をあける事にもなりかねませんので、独自のアクションを実装する際には十分に気をつけて実装して下さい。
特に認証機構を設けてはいませんが、アクションクラスに auth() メソッドを追加する事で自動的に認証を行います。→詳しくはソース。

API として提供する機能はクラス(abstractAction クラスの継承クラス)として実装し、apiInterface::addAction(フック名,アクションクラスのインスタンス) メソッドでフックに登録します。

API の呼び出しは POST メソッドで

<?php
$_POST = array(
    'key' => sha1( プラグインの API キー . アクションクラスの $key ),
    'action' => 実行するアクションのフック名
);
?>

が基本となります。
呼び出すのはどのページでも構いません。key パラメタが合致して action パラメタに有効なフック名が指定されていれば動きます。

POST メソッドで API をリクエストすると登録したアクションクラスの execute( POST ) メソッドが呼び出されます。
execute() メソッドには POST パラメタが渡されますので、独自のパラメタを使う際には POST パラメタに混ぜて渡して下さい。

プラグインにはいくつかサンプルのアクションクラスを実装しています。
action.class.php にその実装があります。
プラグインの動作確認をするにはプラグインの example/example.html にアクセスして下さい。
サンプルアクションにリクエストをするサンプルを掲載しています。
プラグインをインストールしてサンプルを確認するのが面倒だけどどんなものか確認したいと言うめんどくさがりやさんのためにこのページ最下段にサンプルを用意してあります。

がっちがちの実装は好きじゃないので全く同じアクションを重複して登録する事も、アクションクラスのキーを null にする事も可能です。
この辺りの実装が好みでない場合はご自由に拡張して下さい。

アクションクラスの抽象クラスである abstractAction クラスは $key 変数と execute() メソッドが必須となっており、 true を返す auth() メソッドが実装されています。
アクションとしてフックに登録する場合にはこの abstractAction クラスを継承している事が条件です。→詳しくはソース

ふわっふわしたものなので詳しくはソースを読んで下さい。
不明な点があればコメントして下さい。分かる範囲でお答えします。
バグ報告や機能改善案などもあればコメント下さい。僕とお友達になりたいとかでも結構です。

どうやって使うの？

wp-content/plugins ディレクトリにアップロードして、管理画面でプラグインを有効にして下さい。
管理画面の「プラグイン」タブのサブメニューに追加された「API Interface」で設定を行います。
プラグインを有効にするとプラグインの API キーも自動的に設定されますが、特に理由がない限り設定しなおす必要はありません。

制限は？

チェックは Wordpress 2.6 から 2.7.1 で行っています。
それ以前のバージョンでは動かないかもしれません。動かない場合はコメントをもらえれば対応してみます。
また、PHP5 以降でないとどうがんばっても動きません。PHP4 の環境については同情を禁じえませんが、ご理解下さい。

ライセンスは？

Wordpress が GPL なのでこのプラグインももちろん GPL です。
GPL さえ守られていればどのような使い方をされても OK ですが、このプラグインを使うことで何らかの問題が発生してもその責任は負いません。

ダウンロード

以下よりダウンロードして下さい。

• Wordpress に web API インターフェースを追加するプラグイン Version 0.0.1 2009/01/16

サンプル

テストアクション

有効になっているプラグインのリスト

最近投稿した記事のリスト

最近メディアライブラリに投稿した画像リスト

検索