プラグインWooCommerceのwoocommerce_get_transaction_urlフィルタの使用方法・解説

概要

woocommerce_get_transaction_urlフィルタは、WooCommerceのトランザクションに関連するURLを取得・変更するために使用されるフックです。このフィルタは、主に決済プロセスやトランザクション状態の表示をカスタマイズする際に重宝されます。具体的には、以下のような機能を実装する際によく使われます。

1. 決済サービスプロバイダーへのリダイレクトURLの変更
2. 特定の条件に基づくトランザクションURLのカスタマイズ
3. URLに追加パラメータを挿入しての追跡
4. エラーページや成功ページのURLの変更
5. デバッグ用のURLに変更する
6. ユーザーの行動に基づいた動的なURL生成

構文

以下の構文を使用してwoocommerce_get_transaction_urlフィルタを適用します。

add_filter('woocommerce_get_transaction_url', 'callback_function_name', 10, 3);

パラメータ

• string $url: オリジナルのトランザクションURL
• object $order: WooCommerceの注文オブジェクト
• array $request: リクエストに関する配列データ

戻り値

• string: 修正または未修正のトランザクションURLを返します。

WooCommerceのバージョン

• 使用可能: WooCommerce 2.0 以降

WordPressのバージョン

• 使用可能: 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: 決済URLをカスタマイズ

add_filter('woocommerce_get_transaction_url', 'custom_transaction_url', 10, 3);

function custom_transaction_url($url, $order, $request) {
    // 特定の条件に基づいてURLを変更
    if ($order->get_total() > 100) {
        return 'https://example.com/high-value-transaction';
    }
    return $url; // それ以外は元のURLを返す
}

このサンプルコードでは、注文の合計金額が100以上の場合、特定のURLにリダイレクトされます。

（引用元: https://www.example.com）

サンプル2: トランザクションURLにトラッキングパラメータを追加

add_filter('woocommerce_get_transaction_url', 'add_tracking_param', 10, 3);

function add_tracking_param($url, $order, $request) {
    return $url . '?utm_source=woocommerce&utm_medium=transaction';
}

このサンプルでは、トランザクションURLにトラッキングパラメータを追加します。

（引用元: https://www.example.com）

サンプル3: エラーページへのリダイレクト

add_filter('woocommerce_get_transaction_url', 'redirect_to_error_page', 10, 3);

function redirect_to_error_page($url, $order, $request) {
    if ($request['status'] == 'fail') {
        return 'https://example.com/error-page';
    }
    return $url;
}

このサンプルは、トランザクションが失敗した場合にエラーページにリダイレクトします。

（引用元: https://www.example.com）

サンプル4: 成功ページのURL変更

add_filter('woocommerce_get_transaction_url', 'change_success_url', 10, 3);

function change_success_url($url, $order, $request) {
    if ($request['status'] == 'successful') {
        return 'https://example.com/success';
    }
    return $url;
}

このサンプルでは、トランザクションが成功した際のURLを変更します。

（引用元: https://www.example.com）

サンプル5: デバッグ用URLの提供

add_filter('woocommerce_get_transaction_url', 'debug_transaction_url', 10, 3);

function debug_transaction_url($url, $order, $request) {
    if (defined('WP_DEBUG') && WP_DEBUG) {
        return 'https://example.com/debug/' . $order->get_id();
    }
    return $url;
}

このコードは、WP_DEBUGが有効な際にデバッグ用のURLを返します。

（引用元: https://www.example.com）