概要
woocommerce_payment_token_updated アクションは、WooCommerce において、支払いトークンが更新される際にトリガーされるフックです。このアクションは、支払い方法や顧客の支払い情報が変更されたときに特定の処理を実行するためによく使われます。以下は、このフックが実装される際の一般的な例です。
- 顧客の支払いトークンの更新に応じて、関連データを記録する
- 支払い情報の変更時にお知らせを送信する
- 支払い方法に関するカスタムロジックを適用する
- 特定の支払い方法使用時の顧客のフィードバックを収集する
- アプリケーションのログに支払いトークンの変更を記録する
- 特定の条件に基づいたエラーハンドリングを実施する
構文
do_action( 'woocommerce_payment_token_updated', $token_id, $old_token, $new_token );
パラメータ
$token_id(int): 更新されたトークンのID。$old_token(object): 更新前のトークンオブジェクト。$new_token(object): 更新後のトークンオブジェクト。
戻り値
このアクションには戻り値はありません。
使用可能なプラグイン WooCommerce のバージョン
WooCommerce バージョン 2.6 以降で使用可能です。
使用可能なワードプレスのバージョン
WordPress バージョン 4.0 以降で使用可能です。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプル 1: 支払いトークンの更新時にカスタムメッセージを表示
このサンプルコードは、支払いトークンが更新されたときにカスタムメッセージを表示するためのものです。
add_action( 'woocommerce_payment_token_updated', 'custom_payment_token_updated_message', 10, 3 );
function custom_payment_token_updated_message( $token_id, $old_token, $new_token ) {
echo '支払いトークンが更新されました。';
}
引用元: https://developer.wordpress.org/reference/hooks/
サンプル 2: 支払いトークンの更新をログに記録
このコードは、支払いトークンの更新が行われた際、その情報をログファイルに記録します。
add_action( 'woocommerce_payment_token_updated', 'log_payment_token_update', 10, 3 );
function log_payment_token_update( $token_id, $old_token, $new_token ) {
error_log( 'Payment token updated: ID ' . $token_id );
}
引用元: https://developer.wordpress.org/reference/hooks/
サンプル 3: お知らせメールの送信
支払いトークンが更新されたら管理者に通知のメールを送るサンプルです。
add_action( 'woocommerce_payment_token_updated', 'send_admin_email_on_token_update', 10, 3 );
function send_admin_email_on_token_update( $token_id, $old_token, $new_token ) {
wp_mail( get_option( 'admin_email' ), 'トークンが更新されました', 'ID: ' . $token_id );
}
引用元: https://developer.wordpress.org/reference/hooks/
サンプル 4: 特定の条件に基づいたエラーハンドリング
このサンプルでは、特定の条件を満たす場合にエラーメッセージを出力します。
add_action( 'woocommerce_payment_token_updated', 'error_handling_on_token_update', 10, 3 );
function error_handling_on_token_update( $token_id, $old_token, $new_token ) {
if ( empty( $new_token->get_token() ) ) {
echo 'エラー: 新しいトークンが無効です。';
}
}
引用元: https://developer.wordpress.org/reference/hooks/
サンプル 5: カスタムダッシュボードでのトークン情報の更新
管理者用のカスタムダッシュボードにトークンの更新情報を表示します。
add_action( 'woocommerce_payment_token_updated', 'update_dashboard_with_token_info', 10, 3 );
function update_dashboard_with_token_info( $token_id, $old_token, $new_token ) {
// ここでカスタムダッシュボードの処理を実行します
// 例: グラフや表に新しいトークン情報を表示する
}
引用元: https://developer.wordpress.org/reference/hooks/