Google Crisis Response(Google)
災害に関する情報源や、行方不明者情報の収集と検索を行う『パーソンファインダー』を初めとするツールの提供が行われています。

2007年2月18日 日曜日

EntryKeywords 0.5.0 公開しました

Filed under: EntryKeywords,WordPress,プラグイン
時間:15時34分
投稿者:よしとも
AddClips 経由でソーシャルブックマークに登録

 『公開迫る』といいつつ、結局2週間も過ぎてしまいました。自作 WordPress プラグインの EntryKeywords 0.5.0 をやっと公開です。

 公開場所は、予定通り JSeries になりました。その中に専用のページを作り、リリース情報などを掲載するようにしています。

 また、このブログに専用のカテゴリーを新設しました。JSeries はコメントやトラックバックができませんので、必要な場合はカテゴリー内の記事にでもしていただければと思います。

Comments (2)

2007年2月15日 木曜日

WordPress プラグインのトラブル解決

Filed under: EntryKeywords,WordPress,ハック,プラグイン
時間:4時14分
投稿者:よしとも
AddClips 経由でソーシャルブックマークに登録

 フック admin_headdo_action を実行している直前で $wp_filter の中身をすべて表示させてみたところ、あっさり解決しました。
 関数名を検索してみるとしっかり登録されていたので登録内容を確認。フックのところを見たとき愕然としました。

 フック名は、「admin_head 」。後ろに余計なスペースが・・・。

 はい。単なる入力ミスです。こんなのに3日も悩んでたんですか。
 スペルを間違えないようにコピーしてきたときにスペースが入ってしまったのではないかと。本末転倒もいいところです(^^;

 フックは開発者が自由に決められる仕組みなので、スペルミスには注意が必要ですね。構文エラーなら PHP が面倒を見てくれますが、今回のような論理エラーは思い込みなどで気がつくのに時間がかかります。皆さんもご注意くださいませ。

Comments (0)

WordPress プラグインの仕組み

Filed under: EntryKeywords,WordPress,ハック,プラグイン
時間:3時25分
投稿者:よしとも
AddClips 経由でソーシャルブックマークに登録

 自作プラグイン EntryKeywords のオプション設定画面を CSS で装飾したくて作業中。

 マニュアルを見ていて add_action('admin_head ', '関数'); とすればいいはずと目星をつけていましたが、なぜか動いてくれません。2日以上悩み続けています。仕方がないので流れを追いかけてみることに。
 結局動くまでには至っていませんが、せっかくなので仕組みをメモ。

登録

 まず、関数 add_action でフックに対応する関数の登録を行います。2.0.7 では add_filter を呼び出すだけなので、実際の処理は 関数 add_filter を見ます。定義は、/wp-includes/functions.php にあります。

  1. function add_filter($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
  2.     global $wp_filter;
  3.  
  4.     // check that we don't already have the same filter at the same priority
  5.     if ( isset($wp_filter[$tag]["$priority"]) ) {
  6.         foreach($wp_filter[$tag]["$priority"] as $filter) {
  7.             // uncomment if we want to match function AND accepted_args
  8.             // if ( $filter == array($function, $accepted_args) ) {
  9.             if ( $filter['function'] == $function_to_add ) {
  10.                 return true;
  11.             }
  12.         }
  13.     }
  14.  
  15.     // So the format is wp_filter['tag']['array of priorities']['array of ['array (functions, accepted_args)]']
  16.     $wp_filter[$tag]["$priority"][] = array('function'=>$function_to_add, 'accepted_args'=>$accepted_args);
  17.     return true;
  18. }

 フックの登録は、グローバル変数 $wp_filter に配列として登録されます。関数 add_filter の処理は大きく2つに分かれていて、登録処理は後半の部分で行います。前半は重複して登録しないためのチェックです。
 登録処理のコメントにもありますが、登録情報はフックと優先度で分類されています。また、関数にはオブジェクトのメンバー関数も登録できます。その場合は、array(オブジェクトインスタンス, 関数名) という配列を使います。オブジェクトインスタンスは参照渡しする必要があります。そのため、PHP 4 では変数の頭に & をつけて明示的に参照渡しにする必要があります。

実行

 登録した関数を実行するには、関数 do_action を使います。この定義も /wp-includes/functions.php にあります。

  1. function do_action($tag, $arg = '') {
  2.     global $wp_filter;
  3.     $extra_args = array_slice(func_get_args(), 2);
  4.     if ( is_array($arg) )
  5.         $args = array_merge($arg, $extra_args);
  6.     else
  7.         $args = array_merge(array($arg), $extra_args);
  8.  
  9.     merge_filters($tag);
  10.  
  11.     if ( !isset($wp_filter[$tag]) ) {
  12.         return;
  13.     }
  14.     foreach ($wp_filter[$tag] as $priority => $functions) {
  15.         if ( !is_null($functions) ) {
  16.             foreach($functions as $function) {
  17.  
  18.                 $function_name = $function['function'];
  19.                 $accepted_args = $function['accepted_args'];
  20.  
  21.                 if ( $accepted_args == 1 ) {
  22.                     if ( is_array($arg) )
  23.                         $the_args = $arg;
  24.                     else
  25.                         $the_args = array($arg);
  26.                 } elseif ( $accepted_args > 1 ) {
  27.                     $the_args = array_slice($args, 0, $accepted_args);
  28.                 } elseif ( $accepted_args == 0 ) {
  29.                     $the_args = NULL;
  30.                 } else {
  31.                     $the_args = $args;
  32.                 }
  33.  
  34.                 $string = call_user_func_array($function_name, $the_args);
  35.             }
  36.         }
  37.     }
  38. }

 前半は飛ばして、後半の foreach を見ます。
 特定のフックに対する登録情報を順に処理しています。情報を取り出し、引数の処理をし、最後に組み込み関数 call_user_func_array で関数をコールします。

どこまでは動いているのか

 調べた結果、少なくとも add_filter での重複チェックを通過していることはわかりました。最後の return の直前($wp_filter への登録直後)で $wp_filter[$tag]["$priority"] の値を表示させて確認しました。
 add_action を経由しないで直接登録した場合ではきちんと動作しましたので、何らかの理由により登録を削除されているのではないかと考えています。

Comments (1)

2007年2月5日 月曜日

オリジナルプラグイン EntryKeywords の公開迫る

Filed under: EntryKeywords,WordPress,プラグイン
時間:1時49分
投稿者:よしとも
AddClips 経由でソーシャルブックマークに登録

 先月の中ごろから WordPress プラグインの作成に挑んできましたが、もうまもなく公開できると思います。名称は、EntryKeywords。

 機能としては、記事に対してキーワードを複数設定し、それをいろいろと利用しようというものです。再利用を重視している点でタグ系のプラグインとは違います。基本は文字列での表示ですが、配列や JSON で取得できるなど、プログラマ寄りになっています。
 公開場所は WordPress Plugins/JSeries の予定。発案者であるひろまささんには参加の申し込みをしてあるので、現在返事待ちです。

 まだドキュメントもなくベータ版状態ですが、よかったらいじってみてください。GPL ライセンスですので、変更もご自由に。

Comments (1)

2007年1月18日 木曜日

プラグインテスト用兼メモ

Filed under: EntryKeywords,WordPress,ハック,プラグイン
時間:0時38分
投稿者:よしとも
AddClips 経由でソーシャルブックマークに登録

 プラグイン製作に挑むことにしました。このページはそのテスト用です。
 普通の記事ページでもいいのですが、何かあったときの影響範囲を狭めるのと、個別に開くと人気度が変化してしまうために専用の記事を使うことにしました。

メモ

カスタムフィールド
キー
yo_keyword
値を得る

 指定の記事のカスタムフィールドの値を得る。

  1. get_post_meta($post->ID, 'yo_keyword', true);
$post->ID
記事ID
‘yo_keyword’
値がほしいキー
true
このキーが1つだけのときtrue。falseだとリストになる。

プラグインオプションの処理

Saving Plugin Data to the Database

get_option($option):値の取得
add_option($name, $value, $description, $autoload):新規追加
update_option($option_name, $newvalue):更新。ない場合は add_option() が呼ばれる
delete_option($name):オプションの削除

class を使う場合のオプションページ登録

 class を使っている場合(OOP)、add_options_page() の第5引数は次のようにする。

  1. array(&$this, 'function_name')

 この引数が、call_user_func_array() の第1引数になる。これをやらないと、「First argument is expected to be a valid callback」と警告が出る。

フォームの値

 フォームからの値はグローバル変数の $_POST$_GET で得られるが、WordPressはどちらも独自の方法でエスケープしている。(/wp-settings.php
 このエスケープは強制的に行われるため、フォームを使う場合は stripslashes によるアンエスケープが必要。

  1. // If already slashed, strip.
  2. if ( get_magic_quotes_gpc() ) {
  3.     $_GET    = stripslashes_deep($_GET   );
  4.     $_POST   = stripslashes_deep($_POST  );
  5.     $_COOKIE = stripslashes_deep($_COOKIE);
  6. }
  7.  
  8. // Escape with wpdb.
  9. $_GET    = add_magic_quotes($_GET   );
  10. $_POST   = add_magic_quotes($_POST  );
  11. $_COOKIE = add_magic_quotes($_COOKIE);
  12. $_SERVER = add_magic_quotes($_SERVER);

 エスケープ処理を行っている関数 add_magic_quotes() は、/wp-includes/functions.php で定義されている。
 再起処理により、階層の深い配列にも対応するようになっている。

  1. function add_magic_quotes($array) {
  2.     global $wpdb;
  3.  
  4.     foreach ($array as $k => $v) {
  5.         if ( is_array($v) ) {
  6.             $array[$k] = add_magic_quotes($v);
  7.         } else {
  8.             $array[$k] = $wpdb->escape($v);
  9.         }
  10.     }
  11.     return $array;
  12. }

 最終的なエスケープ処理をする $wpdb->escape() は、/wp-includes/wp-db.php で定義されている。$wpdb は クラス wpdb のインスタンス。

  1. // ====================================================================
  2.     //  Format a string correctly for safe insert under all PHP conditions
  3.    
  4.     function escape($string) {
  5.         return addslashes( $string ); // Disable rest for now, causing problems
  6.         if( !$this->dbh || version_compare( phpversion(), '4.3.0' ) == '-1' )
  7.             return mysql_escape_string( $string );
  8.         else
  9.             return mysql_real_escape_string( $string, $this->dbh );
  10.     }

進行具合

 デバッグ&テスト中。
 本番テストということで、アフィリエイト広告のキーワードとして使ってみています。
 記事のメタ情報を利用するため、記事ループの中でないと使えないことが判明。サイドバーのアフィリエイト広告に使いたかったのでちょっと残念。

管理画面スクリーンショット

TODO

  • オプションを保持している変数をクラスオブジェクトにする。
  • メソッドの引数によるオプションの上書き処理を、オプション用クラスのメソッドとして切り離す。
  • 管理画面のオプション設定画面の表示を専用クラスに切り離す。
  • キーワードをランダムに1つ選択するメソッドの実装。
  • オプション設定画面の整理。
  • カスタムフィールドに改行で区切って複数のキーワードが入れられるようにする。
  • キーワードを得る方法に、配列とJSONを追加。

参考資料

Comments (0)

2007年1月15日 月曜日

記事にキーワードをつけるアイディアのメモ

Filed under: EntryKeywords,アフィリエイト,プラグイン
時間:22時34分
投稿者:よしとも
AddClips 経由でソーシャルブックマークに登録

 ちょっと思いついたのでメモ。時間があればプラグインとして作ってみようと思いますが、今はただのメモ。

 実はもうある?ご存知の方ぜひ教えてください。面白そうだから作るよというのも大歓迎です。

アフィリエイト要に記事にキーワードを付ける

 Amazon.co.jp のライブリンクのように、ASP型のアフィリエイトサービスには、キーワードによって表示する商品を動的に決定することができるものがあります。お任せリンクではキーワードの抽出がどうなっているのかわからず曖昧になりがちですが、直接指定することで好きなように決めることができます。

 ブログでは、カテゴリーという概念があります。記事を大まかに分類するわけです。もう少し細かいものにタグがあります。これも一種のキーワードといえますが、アフィリエイト用としてはまだちょっと曖昧な気がします。細かくしすぎるとタグの意味がなくなってしまいますし。

キーワードを記事に紐付ける

 ということで、専用のキーワードという概念が必要であると私は結論付けました。そして、それを WordPress のカスタムフィールドでできないかと考えています。記事の ID と紐付けられた形でデータベースに記録されるようなので、記事 ID からたどって値(ここではキーワード)を取得することも可能なはずです。

 ここまでくればあとは簡単。アフィリエイトの広告表示コードを出力する関数を定義したプラグインを作るだけ。キーワードを URL エンコードして埋め込むようにしてやれば、投稿画面で設定したキーワードを広告表示コードに渡すことができるはずです。表示はテンプレートに関数を埋め込んでもらいます。

柔軟にする

 プラグインオプションの設定画面がほしいですね。
 広告コードを設定することができればいろいろ対応できますし、ほかにもいろいろオプションが必要になるかもしれません。

その他

 キーワードの設定がない場合はカテゴリーを使えばいいでしょうか。オプションで初期値を設定できるというのもありかも。

Comments (0)

HTML convert time: 0.568 sec. Powered by

Images is enhanced with WordPress Lightbox JS by Zeo