Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Mizuno buddypress-plugin

1,233 views

Published on

wordpress plugin のアクションフック、フィルターフックの仕組み。
フックの仕組みを利用して、既存のプラグインをカスタマイズする方法。

Published in: Art & Photos
  • Be the first to comment

  • Be the first to like this

Mizuno buddypress-plugin

  1. 1. 1 プラグインフックの 仕組みとカスタマイズ BuddyPressとSubscribe2 水野 史土 http://php-web.net/ mizuno
  2. 2. 2 WordPress に関する活動 ● WordBench ● 川崎、名古屋、大阪、神戸 ● オープンソースカンファレンス (OSC) ● 東京、名古屋、京都、神戸 ● 公式マニュアル (Codex) ● プラグイン配布 ● ShowID for Post/Page/Category/Tag/Comment ● Select Category to Post
  3. 3. 3 プラグイン ● WP にプログラムを追加(どこで?何を?) ● 追加する場所 → フック ● プログラムの中身 → PHP ● フィルターフックとアクションフック ● WP に多数用意されている ● ソースを読んでフックの箇所を調べる ● プラグイン同士の整合性に注意する ● フック箇所/中身を調べる
  4. 4. 4 フィルターフック ● WP の処理データを改変 ● the_title (記事タイトル) ● excerpt_length (抜粋の長さ) ● フックでプラグインが実行可能 ● add_filter(フック名, プラグイン関数) ● Codex の例: 抜粋の長さを変える ● どこで? → 抜粋 ● 何を? → 長さの変更
  5. 5. 5 WP の処理 抜粋 長さの変更 WP に apply_filters が用意されている add_filter でプラグイン登録 「抜粋の長さを変更」を実行 apply_filters('excerpt_length') add_filter
  6. 6. 6 例: 抜粋の長さを変える function new_excerpt_length($length) { return 20; } add_filter('excerpt_length', 'new_excerpt_length'); フック名 関数 Multibyte patch 使用時は excerpt_mblength
  7. 7. 7 アクションフック ● WP の処理途中の目印 ● wp_head (header.php読込) ● comment_post (コメント投稿) ● フックでプラグインが実行可能 ● add_action(フック名, プラグイン関数) ● Codex の例: HTMLヘッダーにFavicon表示 ● どこで? → ヘッダー読込 ● 何を? → favicon 追加
  8. 8. 8 WP の処理 ヘッダー読込 favicon 追加 WP に do_action が用意されている add_action でプラグイン登録 「favicon 追加」を実行 do_action('wp_head') add_action
  9. 9. 9 例: ヘッダー → favicon表示 function favicon_link() { echo '<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />' . "n"; } add_action('wp_head', 'favicon_link'); フック名 関数
  10. 10. 10 Subscribe2 ● メルマガプラグイン ● どこで? – ユーザー登録時 ● 何を? – メルマガ登録 もちろん記事投稿-メー ル配信もある
  11. 11. 11 WP の処理 ユーザー登録 Subscribe2 に登録する WPのユーザー登録にフックする WP登録と同時にメルマガに登録
  12. 12. 12 BuddyPress ● WPをソーシャルネットワーク化 ● ワードベンチ http://wordbench.org/ ● スローフードあいち http://www.slowaichi.net/ ● 独自の関数、独自フックが多数 ● ソースは比較的綺麗 ● 独自の関数/フックは bp_ で始まる
  13. 13. 13 BuddyPress と他のプラグイン ● WP用のプラグインをBPで使いたい ● BP 独自のフックがある ● そのままで動くとは限らない ● BuddyPressのフックで動かす ● BuddyPressにはフックが多く用意されている ● テンプレートファイルを調べる ● プラグインのフック箇所を書き換える
  14. 14. 14 WP の処理 ユーザー登録 Subscribe2 に登録する BP の処理 ユーザー登録 BPのユーザー登録処理がWPと異なる そのままではメルマガ登録できない
  15. 15. 15
  16. 16. 16 WP の処理 ユーザー登録 Subscribe2 に登録する BP の処理 ユーザー登録 BPのユーザー登録にフックする BP登録と同時にメルマガに登録
  17. 17. 17
  18. 18. 18 Subscribe2のソースを調べる ● メルマガ登録処理をする関数(メソッド) ● s2class->register_form ● フック先を調べる ● add_action('register_form', array(&$this, 'register_form'));
  19. 19. 19 WP の処理 ユーザー登録 Subscribe2 に登録する add_aciton('register_form') は、 WP のユーザー登録にフックする add_action('register_form') do_action('register_form')
  20. 20. 20 BPでのフックの場所を調べる ● WordPress ● ファイル wp-login.php ● フック register_form ● BuddyPress ● ファイル bp-themes/bp-default/registration/register.php ● フック bp_custom_profile_edit_fields ● subscribe2.php で該当箇所を書き換える add_action('register_form', array(&$this, 'register_form')); add_action('bp_custom_profile_edit_fields', array(&$this, 'register_form'));
  21. 21. 21 WP の処理 ユーザー登録 Subscribe2 に登録する BP の処理 ユーザー登録 add_action('bp_custom_profile_edit_fields') に変更して、BP のユーザー登録にフックする do_action('bp_custom_profile_edit_fields') add_action('bp_custom_profile_edit_fields')
  22. 22. 22 プラグイン本体は改変しない ● 前述の方法はプラグイン本体を書き換える ● プラグインアップデート時に困る ● プラグイン本体は書き換えない方法 ● functions.php に書く if ( class_exists('s2class') && $mysubscribe2 instanceof s2class ) { add_action('bp_custom_profile_edit_fields', array(&$mysubscribe2, 'register_form')); }
  23. 23. 23 参考資料&ライセンス ● Codex http://wpdocs.sourceforge.jp/ ● BuddyPress http://buddypress.org/ ● Subscribe2 http://subscribe2.wordpress.com/ ● CC-BY-SA 表示&継承 ● 誰でも自由に利用可能
  24. 24. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 1 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 1 プラグインフックの 仕組みとカスタマイズ BuddyPressとSubscribe2 水野 史土 http://php-web.net/ mizuno
  25. 25. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 2 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 2 WordPress に関する活動 ● WordBench ● 川崎、名古屋、大阪、神戸 ● オープンソースカンファレンス (OSC) ● 東京、名古屋、京都、神戸 ● 公式マニュアル (Codex) ● プラグイン配布 ● ShowID for Post/Page/Category/Tag/Comment ● Select Category to Post ワードベンチ:川崎、名古屋、大阪、神戸 ユーザー同士で交流 OSC:東京、名古屋、京都、神戸 他のCMS(Concrete5, Drupal, Geeklog, Joruri, MODx, Typo3等)やLinux、MySQL等、 ウェブを支えるコミュニティと交流 公式マニュアル ドキュメントの共有 プラグイン ShowID for Post/Page/Category/Tag/Comment Select Category to Post(公式に登録準備中)
  26. 26. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 3 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 3 プラグイン ● WP にプログラムを追加(どこで?何を?) ● 追加する場所 → フック ● プログラムの中身 → PHP ● フィルターフックとアクションフック ● WP に多数用意されている ● ソースを読んでフックの箇所を調べる ● プラグイン同士の整合性に注意する ● フック箇所/中身を調べる プラグイン: どこで、何をするかを決める ワードプレス本体の機能はそれほど多くない プラグインを作ることで拡張可能 フィルターとアクションの2種類のフック 公式マニュアルの例を元に解説 プラグイン同士が競合することがある それぞれのプラグイン中身を調べておく フックする箇所に注意する
  27. 27. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 4 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 4 フィルターフック ● WP の処理データを改変 ● the_title (記事タイトル) ● excerpt_length (抜粋の長さ) ● フックでプラグインが実行可能 ● add_filter(フック名, プラグイン関数) ● Codex の例: 抜粋の長さを変える ● どこで? → 抜粋 ● 何を? → 長さの変更 フィルターフックとアクションフックがある ワードプレスの処理データを変更する場合はフィル ターを使う
  28. 28. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 5 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 5 WP の処理 抜粋 長さの変更 WP に apply_filters が用意されている add_filter でプラグイン登録 「抜粋の長さを変更」を実行 apply_filters('excerpt_length') add_filter 抜粋の長さを変更する ワードプレス側 apply_filters が用意されている プラグインの側 フィルターに対する処理を書く add_filter でフックする
  29. 29. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 6 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 6 例: 抜粋の長さを変える function new_excerpt_length($length) { return 20; } add_filter('excerpt_length', 'new_excerpt_length'); フック名 関数 Multibyte patch 使用時は excerpt_mblength フィルターフックの例 抜粋の長さ(デフォルト55単語)を変更できる 日本語の場合(マルチバイトパッチ使用)は、 excerpt_mblength で設定する
  30. 30. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 7 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 7 アクションフック ● WP の処理途中の目印 ● wp_head (header.php読込) ● comment_post (コメント投稿) ● フックでプラグインが実行可能 ● add_action(フック名, プラグイン関数) ● Codex の例: HTMLヘッダーにFavicon表示 ● どこで? → ヘッダー読込 ● 何を? → favicon 追加 アクションフックは、ワードプレスの処理の目印 フックのある箇所で、プラグイン実行 PHP で記述するので、自由度、汎用性に優れる
  31. 31. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 8 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 8 WP の処理 ヘッダー読込 favicon 追加 WP に do_action が用意されている add_action でプラグイン登録 「favicon 追加」を実行 do_action('wp_head') add_action ヘッダー読込時にファビコンを追加する ワードプレス側 do_action が用意されている プラグイン側 フックでの処理を書く フックする場所を add_action で指定する
  32. 32. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 9 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 9 例: ヘッダー → favicon表示 function favicon_link() { echo '<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />' . "n"; } add_action('wp_head', 'favicon_link'); フック名 関数 HTML ヘッダー部分に、ファビコンを表示する wp_head のところで、ヘッダー出力処理をする ワードプレス本体やテンプレートを改変しないでカ スタマイズできる
  33. 33. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 10 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 10 Subscribe2 ● メルマガプラグイン ● どこで? – ユーザー登録時 ● 何を? – メルマガ登録 もちろん記事投稿-メー ル配信もある サブスクライブは、メルマガ配信プラグイン ユーザー登録時に、「メルマガ登録する?」か選択 可能 もちろん、記事投稿 → メール投稿という処理がメイ ンだが、今回取り上げるのはこちら
  34. 34. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 11 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 11 WP の処理 ユーザー登録 Subscribe2 に登録する WPのユーザー登録にフックする WP登録と同時にメルマガに登録 サブスクライブは、ワードプレスのユーザー登録に フックしている ワードプレスのユーザー登録時に、「メルマガ登 録」も一緒に行うことができる
  35. 35. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 12 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 12 BuddyPress ● WPをソーシャルネットワーク化 ● ワードベンチ http://wordbench.org/ ● スローフードあいち http://www.slowaichi.net/ ● 独自の関数、独自フックが多数 ● ソースは比較的綺麗 ● 独自の関数/フックは bp_ で始まる バディプレスは、ソーシャルネットワークシステム を作るためのプラグイン 利用例:ワードベンチ、スローフードあいち等 技術的な話 バディプレス独自の関数、独自のフックがたく さん用意されている ソースは綺麗(WP本体は汚い)中身を理解し やすい 独自の関数やフックは bp_ で始まる 他のプラグインと名前が被ることはまず無い
  36. 36. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 13 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 13 BuddyPress と他のプラグイン ● WP用のプラグインをBPで使いたい ● BP 独自のフックがある ● そのままで動くとは限らない ● BuddyPressのフックで動かす ● BuddyPressにはフックが多く用意されている ● テンプレートファイルを調べる ● プラグインのフック箇所を書き換える バディプレスには、独自のフックがある ワードプレス用プラグインがそのまま動作するとは 限らない プラグインのフック箇所を調べて、バディプレスの フックに書き換える
  37. 37. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 14 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 14 WP の処理 ユーザー登録 Subscribe2 に登録する BP の処理 ユーザー登録 BPのユーザー登録処理がWPと異なる そのままではメルマガ登録できない バディプレスは独自の登録画面を用意しており、そ こからユーザー登録する サブスクライブをそのままインストールした場合、 バディプレスのユーザー登録にフックしていない ので、バディプレスの登録画面で「メルマガ登 録」を一緒にはできない 一度にできるほうが、ユーザーにとって嬉しい
  38. 38. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 15 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 15
  39. 39. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 16 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 16 WP の処理 ユーザー登録 Subscribe2 に登録する BP の処理 ユーザー登録 BPのユーザー登録にフックする BP登録と同時にメルマガに登録 サブスクライブのフック先をバディプレスの登録画 面に変更すればOK
  40. 40. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 17 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 17
  41. 41. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 18 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 18 Subscribe2のソースを調べる ● メルマガ登録処理をする関数(メソッド) ● s2class->register_form ● フック先を調べる ● add_action('register_form', array(&$this, 'register_form')); プラグインのソースを調べる メルマガ登録処理をしている関数(オブジェクト指 向なので、メソッド)を調べる s2class->register_form そのメソッドがフックしている場所を調べる register_form
  42. 42. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 19 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 19 WP の処理 ユーザー登録 Subscribe2 に登録する add_aciton('register_form') は、 WP のユーザー登録にフックする add_action('register_form') do_action('register_form') プラグインの初期設定 add_action('register_form') ワードプレスのユーザー登録にフックしている バディプレスのユーザー登録画面では、フック を呼び出ししない
  43. 43. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 20 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 20 BPでのフックの場所を調べる ● WordPress ● ファイル wp-login.php ● フック register_form ● BuddyPress ● ファイル bp-themes/bp-default/registration/register.php ● フック bp_custom_profile_edit_fields ● subscribe2.php で該当箇所を書き換える add_action('register_form', array(&$this, 'register_form')); add_action('bp_custom_profile_edit_fields', array(&$this, 'register_form')); サブスクライブがフックしている場所をワードプレ ス、バディプレスのソースを調べて探す ワードプレスでは、wp-login.php の register_form バディプレスでは、register.php の bp_custom_profile_edit_fields サブスクライブプラグインの、フック箇所を書き換 えることで、バディプレスのユーザー登録画面に フックする
  44. 44. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 21 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 21 WP の処理 ユーザー登録 Subscribe2 に登録する BP の処理 ユーザー登録 add_action('bp_custom_profile_edit_fields') に変更して、BP のユーザー登録にフックする do_action('bp_custom_profile_edit_fields') add_action('bp_custom_profile_edit_fields') サブスクライブのフック先をバディプレスの登録画 面に変更すればOK bp_custom_profile_edit_fields にフックする Subscribe2.php を書き換えれば解決する
  45. 45. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 22 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 22 プラグイン本体は改変しない ● 前述の方法はプラグイン本体を書き換える ● プラグインアップデート時に困る ● プラグイン本体は書き換えない方法 ● functions.php に書く if ( class_exists('s2class') && $mysubscribe2 instanceof s2class ) { add_action('bp_custom_profile_edit_fields', array(&$mysubscribe2, 'register_form')); } プラグイン本体は書き換えないようにすると、プラ グインアップデート時に楽(大幅に仕様変更が あった時は別だが) Subscribe2 プラグインはカスタマイズしやすいよう に記述されている。オブジェクト指向で書かれて いないプラグインだと大変かもしれない。
  46. 46. Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 23 Oct. 30, 2010 Mizuno WordCamp Nagoya 2010 23 参考資料&ライセンス ● Codex http://wpdocs.sourceforge.jp/ ● BuddyPress http://buddypress.org/ ● Subscribe2 http://subscribe2.wordpress.com/ ● CC-BY-SA 表示&継承 ● 誰でも自由に利用可能 公式マニュアル、プラグインのサイトの紹介 この資料のライセンス クリエイティブコモンズ表示継承 引用元を表記する 同一ライセンスにする を満たせば、誰でも自由に利用可能 ワードプレス、ブラグイン、バディプレスに興味を もった人は、自由に使ってください。

×