プラグインWooCommerceのwoocommerce_payment_token_object_updated_propsアクションの使用方法・解説

概要

woocommerce_payment_token_object_updated_propsは、WooCommerceの決済トークンオブジェクトが更新されたときに実行されるアクションフックです。このフックは、主に決済処理やユーザーの支払い情報に関連するカスタマイズを行う際に利用されます。具体的には以下のような用途で使われることが多いです。

支払いトークンのカスタムプロパティの更新
トークンデータのカスタムバリデーション
ユーザーインターフェイスでのトークン情報の拡張
トークンのロギングやトラッキング
他のプラグインやシステムとの統合
支払い方法のカスタマイズ

構文

do_action( 'woocommerce_payment_token_object_updated_props', $token, $updated_props );

パラメータ

$token: 更新された払い戻しのトークンオブジェクト。
$updated_props: 更新されたプロパティの配列。

戻り値

このアクションフック自体では戻り値はありません。

使用可能なプラグインのバージョン

WooCommerce: 3.0以降のバージョン
WordPress: 4.7以降のバージョン

この関数のアクションでの使用可能性

アクション名	使用例
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_object_updated_props', 'custom_woocommerce_payment_token_updated_props', 10, 2 );

function custom_woocommerce_payment_token_updated_props( $token, $updated_props ) {
    // デフォルトのトークンプロパティを追加
    $token->set_meta('custom_property', 'custom_value');
}

このコードは、WooCommerceの決済トークンにカスタムプロパティを追加します。

サンプルコード2: トークンのバリデーション

add_action( 'woocommerce_payment_token_object_updated_props', 'validate_payment_token', 10, 2 );

function validate_payment_token( $token, $updated_props ) {
    // 更新されたプロパティのバリデーション
    if ( empty( $updated_props['token'] ) ) {
        // エラー処理
        return;
    }
}

この例では、トークン情報のバリデーションを行っています。無効なトークンの場合はエラー処理を実行します。

サンプルコード3: トークンのロギング

add_action( 'woocommerce_payment_token_object_updated_props', 'log_payment_token_update', 10, 2 );

function log_payment_token_update( $token, $updated_props ) {
    error_log('Payment token updated: ' . json_encode($updated_props));
}

このコードは、トークンの更新時にその情報をログに記録します。

サンプルコード4: UIの拡張

add_action( 'woocommerce_payment_token_object_updated_props', 'extend_token_ui', 10, 2 );

function extend_token_ui( $token, $updated_props ) {
    // ユーザーが見るインターフェースを拡張
    echo '<div>Newly updated property: ' . esc_html($updated_props['some_property']) . '</div>';
}

このサンプルでは、更新されたプロパティをユーザーインターフェースに表示します。

サンプルコード5: 他のプラグインとの統合

add_action( 'woocommerce_payment_token_object_updated_props', 'integrate_with_other_plugin', 10, 2 );

function integrate_with_other_plugin( $token, $updated_props ) {
    // 他のプラグインと統合するための処理
    if ($updated_props['payment_method'] === 'specific_method') {
        // 特定の処理を実行
    }
}

このコードは、WooCommerceの特定の支払い方法でのトークン更新時に、他のプラグインとの統合処理を行います。

これらのサンプルコードは著作権フリーであり、WooCommerceの拡張に役立つ典型的な用途を示しています。

概要

構文