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

概要

woocommerce_gateway_method_descriptionは、WooCommerceのプラグイン内で決済ゲートウェイの説明文をフィルタリングするために使用されるフックです。このフィルタは、決済方法に関連するヘルプや説明文をカスタマイズする際に特に役立ちます。以下は、よく使われる一般的な機能の例です。

決済方法の追加説明を提供
地域ごとの特定の決済オプションを明示
ユーザーのニーズに合わせたカスタマイズなメッセージの表示
特定のプロモーションや割引の情報を表示
取引の安全性やメリットについての情報提供
テスト環境と本番環境の違いを説明するための条件付きメッセージ表示

構文

add_filter( 'woocommerce_gateway_method_description', 'your_custom_function', 10, 2 );

パラメータ

$description (string): 決済ゲートウェイの元の説明文。
$payment_method (WC_Payment_Gateway): 現在の決済ゲートウェイのインスタンス。

戻り値

このフィルタによって返されるのは、カスタマイズされた決済ゲートウェイの説明文（string）です。

使用可能な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: 基本的な説明の追加

このサンプルでは、特定の決済方法に対して追加の説明を追加しています。

add_filter( 'woocommerce_gateway_method_description', 'custom_gateway_description', 10, 2 );

function custom_gateway_description( $description, $payment_method ) {
    if ( 'stripe' === $payment_method->id ) {
        $description .= '<p>Stripeは、迅速で安全な支払いを提供します。</p>';
    }
    return $description;
}

引用元: https://www.example1.com

サンプル2: 地域に基づくメッセージの変更

地域に応じて異なる説明文を表示するサンプルコードです。

add_filter( 'woocommerce_gateway_method_description', 'regional_payment_description', 10, 2 );

function regional_payment_description( $description, $payment_method ) {
    if ( 'paypal' === $payment_method->id && WC()->customer->get_country() === 'JP' ) {
        $description .= '<p>日本専用のPayPalサービスをご利用いただけます。</p>';
    }
    return $description;
}

引用元: https://www.example2.com

サンプル3: プロモーションの説明を追加

特定の決済オプションに関してプロモーション情報を表示するサンプルです。

add_filter( 'woocommerce_gateway_method_description', 'add_promotion_description', 10, 2 );

function add_promotion_description( $description, $payment_method ) {
    if ( 'bank_transfer' === $payment_method->id ) {
        $description .= '<p>今なら銀行振込で5％オフ！</p>';
    }
    return $description;
}

引用元: https://www.example3.com

サンプル4: 決済の安全性情報の追加

安全性についての情報を提供するためのサンプルコードです。

add_filter( 'woocommerce_gateway_method_description', 'security_information_description', 10, 2 );

function security_information_description( $description, $payment_method ) {
    if ( 'authorize_net' === $payment_method->id ) {
        $description .= '<p>お客様の情報はSSLで保護されています。</p>';
    }
    return $description;
}

引用元: https://www.example4.com

サンプル5: 環境に応じた説明

テスト環境と本番環境の違いを強調するサンプルコードです。

add_filter( 'woocommerce_gateway_method_description', 'environment_based_description', 10, 2 );

function environment_based_description( $description, $payment_method ) {
    if ( 'square' === $payment_method->id && defined('WP_ENV') && WP_ENV === 'development' ) {
        $description .= '<p>この環境はテスト環境です。実際の取引には使用しないでください。</p>';
    }
    return $description;
}

引用元: https://www.example5.com

これらのサンプルコードを利用して、具体的なニーズに応じた決済ゲートウェイの説明文のカスタマイズが可能です。

概要

構文