フックとは何か

WordPress のプラグインAPI は、固定で出力される部分をユーザーが自由に変更できる仕組み（フィルター）と、特定のタイミングで独自の処理をさせる事ができる仕組み（アクション）の2通りの機能を持っています。しかも、この仕組みは本体を改変することは無いのでアップグレードの際にカスタマイズが消えてしまうということは有りません。

例えば記事タイトルを表示する処理に、ユーザーが作成した処理を割り込ませてタイトルを書き換えてしまったり、記事がデータベースに保存されるタイミングで別の処理を実行させたりと、ユーザーはかなりいろんな事ができるようになっています。

前もって作った関数を、本体の特定の位置（フック）に引っ掛けておきます。そこへ処理が流れてきた時にその関数が実行されるという仕組みになっているのです。

2つのフック

• フィルター・フック apply_filters() ・・・・ htmlなどテキストを修正して返すフック
• アクション・フック do_action() ・・・・ 処理を実行するのみで値は返さないフック

下記のコードは、ベストセラー・ウィジェットのリストを生成しているテンプレートタグusces_list_bestseller() のコードの一部で、フィルター･フックの例です。
このコードは本体に書かれているもので、これを改変してはいけません。

	$htm = '<ul>';
	for($i=0; $i<$num; $i++){
		if(isset($ids[$i])){
			$post = get_post($ids[$i]);
			$disp_text = apply_filters('usces_widget_bestseller_auto_text', wp_specialchars($post->post_title), $ids[$i]);
			$list = '<li><a href="' . get_permalink($ids[$i]) . '">' . $disp_text . '</a></li>';
			$htm .= apply_filters('usces_filter_bestseller', $list, $ids[$i], $i);
		}
	}
	$htm .= '</ul>';

apply_filters() の第1引数はフック名です。この場合 usces_filter_bestseller という名前のフックということになります。
第2引数は、何も無ければ表示されるデフォルトのテキストです。
第3引数以降は任意で、ユーザーが必要だろうと思われるデータが設置されています。

この apply_filters() は、ユーザー関数が無ければ第2引数をそのまま返し、あればユーザー関数の返り値を返すという動きをします。

どうやってフックに引っ掛けるか

フックが有ってユーザー関数がある。では、ユーザー関数はどの様にしてフックに紐付け（フックに引っ掛け）られるのかを見て行きます。

2つの紐付け関数

• add_filter() ・・・・ ユーザー関数をフィルター･フックに紐付ける
• add_action() ・・・・ ユーザー関数をアクション･フックに紐付ける

下記のコードは、ベストセラー・ウィジェットのリストを整形するためのコードです。
このコードは、ユーザーが利用中のテーマのフォルダ内にある functios.php などに記述します。

add_filter('usces_filter_bestseller', 'my_bestseller_func', 10, 3);
function my_bestseller_func() {
	$args = func_get_args();
	list($html, $post_id, $index) = $args;
	$post = get_post($post_id);
	$list = '<li>第' . ($index+1) . '位<a href="' . get_permalink($post_id) . '">' . $post->post_title . '</a></li>';
	return $list;
}

add_filter() が紐付け関数です。

第1引数が引っ掛けるフックの名前です。

第2引数はユーザー関数名。自由に名前を付けられます。バッティングしないように気をつけます。

第3引数は優先度。 このフックを利用するユーザー関数が複数有った場合の優先度です。とりあえず10にしておきましょう。

第4引数はフックから取得できる変数の数です。この引数の必要性があまり感じられないのですが、省略すると1つしか取得できなくなります。ここではフックが3つのデータをユーザーに送っていますので3として全てを受け取れるようにします。

ユーザー関数

フックからのデータを受け取る

$args = func_get_args();　←　重要！

func_get_args() はフックから送ってくる引数を取得する関数です。

一つしか取得する変数が無い場合はこの様にしてもOKです。

 function my_bestseller_func( $html ) { 

受け取ったデータを下にhtml を生成して、最後に return で返してやります。

例）タイトルに飾り付けを

WordPress 本体に、’the_title’　というフィルター・フックが有ります。これを使って記事タイトルに飾りを付けてみましょう。但し、一覧表示のページ（カテゴリーページなど）のタイトルは変更しないこととします。

add_filter('the_title', 'my_title', 10);
function my_title( $title ){
	if( is_singular() && in_the_loop() ){
		$title = '★' . $title;
	}
	return $title;
}

フィルター･フック ‘the_title’ は、テンプレートタグ the_title() に設置されているフックです。従ってこのテンプレートタグでタイトルを表示している部分全てに影響を与えてしまいます。

そのため、is_singular() という条件分岐タグで単体ページだった場合といった条件をつけます。それでもヘッダーやサイドバーのメニューに★が付いてしまいますので、in_the_loop() で条件をきります。これで単体ページの記事タイトルだけに★マークが付きます。

条件を付けなかった時にどうなるか実際に確認してみてください。

カスタマイズのコツ

この様に、フックをうまく使うことで自分の思い通りの出力ができるわけですが、使い方は解っても実際にカスタマイズとなると、何からどう手を付けていいのかピンと来ないかもしれません。そんな時は次のように整理してみると良いかもしれません。

1. カスタマイズしたい部分はどこに書かれているか
まずはどのファイルのどこに書かれているかを知らなくては始まりません。予想されるキーワードでマルチ検索してコードを探してみましょう。どうしてもわからない場合は「開発フォーラム」で質問してください。

2. 該当箇所にフックがあるか
フックが有った場合はどんな引数を持っているを確認して、その引数やグローバル変数で自分のやりたい事ができるかどうかを判断する。
フックが無い場合は「開発フォーラム」に提案してみましょう。

3. ユーザー関数をどこに設置するか
設置する場所はテーマフォルダ内のfunctions.php になります。ここでは説明しませんでしたが、カスタマイズの規模が大きい場合は拡張プラグインを作成する方が管理しやすいでしょう。プラグインの作成方法はWordPress Codex を参照してください。

カスタマイズは、原則的にフックを利用して行われるべきです。本体は必ずアップグレードされます。その中には脆弱性の修正が含まれているかもしれません。本体を改変することはブランチを作り出すことであり、今後アップグレードができなくなることをクライアントに明確に説明しなくてはいけないでしょう。

参考資料

今回は主にフィルター･フックを例に挙げて説明いたしましたが、アクション･フックもとても便利です。例えば、アクション･フックを使うと注文完了時に自前のデータベース（テーブルに）独自のデータを記録する、何てこともできるでしょう。

また紐付け関数も、上に挙げたもの以外に紐付け関係を解消するためのものなどが有ります。興味が有りましたらWordPress Codex プラグインAPI をご覧ください。

Welcart はWordPress をECシステムに変身させるプラグインです。しかしWordPress 本体をハックするようなことはしていません。WordPress には、本体をハックせずに機能を変更・拡張できる仕組みがあります。それが「プラグインAPI」です。
WordPress Codex にはこう書かれています。「WordPress はプラグインを WordPress 本体に “引っ張り込む (hook into)” ためのフックを提供しています。これはつまり、特定のタイミングでプラグインの関数を呼び出したり、それによってプラグインを作動させたりするためのものです。」
Welcart もこの仕組みを利用してWordPress の機能を拡張しています。

Welcart 本体にもフックが有れば、そのフックに引っ掛けて自分の関数を実行できるはず。つまりWelcart をハックせずにカスタマイズが可能ということです。実は、多くのプラグイン制作者がしているように、Welcart にもたくさんの独自のフックが設置されています。例えば’usces_filter_selling_price’ というフックは、「販売価格」という表示ラベルを出力させる際に適用されるフィルターフックです。このフックに対して「受講料」と出力する関数を設置すると、表示ラベルを「販売価格」から「受講料」にカスタマイズする事ができるのです。

現在、Welcart に設置されているフックは、上記のような表示を変えるものから、入力フォームのチェックを変更するものや、インクルードするテンプレートを変更するものなど様々です。他にもどんなフックが存在するのかを調べるには’apply_filters’ 若しくは、’do_action’ のキーワードでコードを検索してみてください。Dreanweaver などのフォルダー内検索で簡単に全てのフックを探し出せます。

しかし、Welcart に設置されているフックは限定的でまだまだ足りないと思っています。もしご自分が変更を加えたいところにフックが存在しなかったら、開発フォーラムで提案してみてください。フックの設置は精査されなくてはいけませんが、まだまだ余裕が有りますのでご要望のフックを設置できる可能性は高いはずです。万が一提案したフックが採用されなかったとしても、ご自分でそのフックの設置を行うことでメンテナンス性をあげる事ができます。なぜならば、「どのファイルのどこにフックを設置した」ということだけを管理していればよいからです。アップグレードのための補修はフックを設置しなおすだけで済みます。

もちろん、Welcart のフックを利用してさえいればメンテナンスを必要としないアップグレードが保障されるというわけでは有りません。仕様の変更でカスタマイズ自身も修正を加えなくてはいけない場面もあるでしょう。それでも、直接本体をハックするよりも格段にメンテナンス性を高める事ができるはずです。

クライアントからの要求を実現させるというビジネスは当然で、Welcart はそういったビジネスを応援します。やむを得ず本体をハックする必要が出てくる場面もあるでしょう。その様な場合、アップグレードの際に必要となる補修（メンテナンス）の工数は直接クライアントの利益となるものです。単に要望を実現できるだけではなく、どれだけメンテナンス性の高いカスタマイズができるかが、真に制作者・開発者に求められているものだと思います。その重要なポイントが「WordPress プラグインAPI」なのです。

Welcart Home では、この様にクライアントサイドに立ったショップ制作ができる業者様をページ上で紹介していきたいと思います。個人・法人は問いません。Welcart を利用して制作したショップを見せて頂き（公開はしません）、どの様にカスタマイズされたかをご説明ください。（コードを見せていただく必要があります）
応募は問合せフォームより送信してください。少し審査に時間がかかるかもしれませんが、こちらから追ってご連絡させて頂きます。

Welcart は不具合修正などアップグレードを頻繁に行います。アップグレードが可能な範囲でのカスタマイズをお勧めします。

[対象のファイル]

退避させる事ができるファイルはusc-e-shop/templates/ 内のファイル全てです。

• usc-e-shop/templates/cart/cart.php（カートページ）
• usc-e-shop/templates/cart/completion.php（完了ページ）
• usc-e-shop/templates/cart/confirm.php（確認ページ）
• usc-e-shop/templates/cart/customer_info.php（お客様情報ページ）
• usc-e-shop/templates/cart/delivery_info.php（配送・支払方法ページ）
• usc-e-shop/templates/cart/error.php（エラーページ）
• usc-e-shop/templates/cart/maintenance.php（メンテナンスページ）
• usc-e-shop/templates/member/changepassword.php（パスワード変更ページ）
• usc-e-shop/templates/member/completion.php（完了ページ）
• usc-e-shop/templates/member/login.php（ログインページ）
• usc-e-shop/templates/member/lostpassword.php（パスワード要求ページ）
• usc-e-shop/templates/member/member.php（会員情報ページ）
• usc-e-shop/templates/member/member_form.php（新規入会ページ）
• usc-e-shop/templates/search_item.php（商品検索ページ）
• usc-e-shop/templates/single_item.php（商品詳細ページ）
• usc-e-shop/templates/wp_search_item.php（その他のページ）

[退避先]

退避先は、plugins/usc-e-shop/ 以外であればどこでも構いませんが、ここではテーマフォルダ（uCart defaultテーマの場合）に退避させる方法を説明いたします。

wp-content/themes/ucart_default/ 内に退避（複写）する

デフォルトテーマにsingle_item.php を設置するには、ucart_default ディレクトリ内にtemplates ディレクトリを作成しその中に設置します。パスは次のようになります。

wp-content/themes/ucart_default/templates/single_item.php

cart.php の場合は次のようになります。

wp-content/themes/ucart_default/templates/cart/cart.php

この様に、テーマフォルダ内にプラグインのtemplates ディレクトリの構造のまま設置します。

注意！！ カスタマイズしていないファイルは退避させないでください。

[パッチをあてる]

テーマ内のfunctions.php に次のコードを追加してください。

cart.php を設置した場合

add_action('init', 'my_welcart_template', 9);
function my_welcart_template(){
add_filter('usces_template_path_cart', 'my_welcart_cart_path');
}
function my_welcart_cart_path( $path ){
$path = get_stylesheet_directory() . '/templates/cart/cart.php';
return $path;
}

cart.php とsingle_item.php を設置した場合

add_action('init', 'my_welcart_template', 9);
function my_welcart_template(){
add_filter('usces_template_path_cart', 'my_welcart_cart_path');
add_filter('usces_template_path_single_item', 'my_welcart_single_item_path');
}
function my_welcart_cart_path( $path ){
$path = get_stylesheet_directory() . '/templates/cart/cart.php';
return $path;
}
function my_welcart_single_item_path( $path ){
$path = get_stylesheet_directory() . '/templates/single_item.php';
return $path;
}

[フィルター対応表]

この様に読み込むテンプレートを変更する事ができます。
これで安心してアップグレードができます


注意！！
・プラグイン内のテンプレートファイルは削除せずそのままにして置いてください。
・テーマ内に設置するテンプレートファイルは変更したものだけにします。
・パッチも変更したものだけをあてるようにしてください。
・テンプレートのカスタマイズは、その内容次第ではアップグレードの際不具合が出る可能性もあるので動作テストは十分に行ってください。

サポートページで、商品ページのデザインは、cssのみというようなことが書かれていますが、どうしてもHTML部分をいじりたければプラグインのPHPをバージョンアップごとに書き換える、という認識でよろしいでしょうか？

できればパージョンアップの手間を減らしたいので、なにか効率の良い方法がありましたらお願いします。
（ちなみに以前紹介されていたhttp://www.yama-ko.com/ ではやはりプラグイン自体を書き換えているように見えますね。）

ではお手数をおかけしますがよろしくお願いします。

どうぞよろしくおねがいいたします。

引き続き色々とチャレンジ中なのですが、少し質問させてください。

可能であれば、会員登録したユーザーだけが見れる[会員限定セール]のカテゴリーを設けたいのですが、そのようなカスタマイズは可能でしょうか？

宜しくお願いいたします。

＜?php //$posts_per_page = 8; ?＞

の８→４に変更しても変わらないのですが、どのタグを変更すれば、表示数変更できますでしょうか？

また別件になりますが、商品詳細テンプレート（single_item.php）でオプション品紹介する場合は、商品コードを○○○の場合、画像名を○○○-1連番として、対応できますが、任意で選択するといったことはできませんか？具体的には関連商品として、セレクトしたいのですが、登録の仕方等で案ありましたら教えていただけますでしょうか？

最後に要望ですが、管理画面商品マスターで選択した商品を一括でカテゴリ-変更や、公開非公開を変更できるようにはできませんでしょうか？

以上宜しくお願いします。

ギフトやプレゼント発送などで、ラッピング（有料で）のオプションは導入できませんでしょうか？バリエーションでラッピング代プラスした価格を登録するのもスマートじゃないので、またラッピングといった商品をつくってオプションで一緒にカートにいれてもらうのもどうかと・・何か案があればお願いします。

もう一点教えて頂きたいのは商品紹介ページで　”在庫：在庫有り”　”在庫：入荷待ち”の分類を追加はできないでしょうか？”在庫：受注生産”といった項目を追加したいのですが・・可能ですか？

お世話になります。

「Welcart」を利用され、外部決済を実装されている方々で情報交換したいと思い投稿させてください。（コミュニティー掲載に相応しくなければ、お手数ですが削除して下さい）

私は、「Welcart」＋「Paypal決済」での運用を考えており構築を進めているのですが、なかなか思うように進捗せず行き詰っております。すでに運用を開始され「Welcart」＋「Paypal決済」を実装されている方おりましたらカスタマイズなどの留意点について情報交換させていただければ幸いに存じます。

また、同様に「Welcart」＋「クレジットl決済」についても参考となる情報が御座いましたらご教授ください。

何卒、宜しくお願い申し上げます。