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

概要

woocommerce_gateway_descriptionは、WooCommerceの決済ゲートウェイに関連する説明文をフィルタリングするためのフックです。このフィルタを使用することで、支払いオプションごとに異なる説明を表示したり、カスタマイズした説明を追加することができます。このフィルタは、オンラインストアのユーザーエクスペリエンスを向上させるために便利です。

よく使われる機能

支払いオプションのカスタマイズされた説明を追加する。
特定の条件に基づいて異なる説明を表示する。
説明文を多言語化する。
説明文にプロモーション情報を埋め込む。
特定のユーザーグループ向けに異なるテキストを表示する。
定期的な更新を行うことでユーザーに最新情報を提供する。

構文

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

パラメータ

$description (string): 現在の説明文。
$gateway_id (string): 使用中のゲートウェイのID。

戻り値

(string): フィルタ後の説明文。

WooCommerceおよびWordPressのバージョン

WooCommerce: 2.0.0以上
WordPress: 3.0.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_description', function( $description, $gateway_id ) {
    if ( $gateway_id === 'stripe' ) {
        return '今すぐ安全にお支払いできます。';
    }
    return $description;
});

サンプルコード2: ユーザーのロールに基づく説明文の変更

このサンプルは、ユーザーが特定のロールを持っている場合にのみ、異なる説明を表示します。

add_filter( 'woocommerce_gateway_description', function( $description, $gateway_id ) {
    if ( current_user_can( 'premium_user' ) ) {
        return 'プレミアムユーザー専用の支払いオプションです。';
    }
    return $description;
});

サンプルコード3: カスタムプロモーションメッセージの追加

このコードは、支払いオプションにプロモーション情報を追加します。

add_filter( 'woocommerce_gateway_description', function( $description, $gateway_id ) {
    return $description . '<br /><strong>今なら送料無料キャンペーン中！</strong>';
});

サンプルコード4: 異なる言語の説明を表示

このサンプルは、サイトが多言語対応の場合に、適切な説明文を表示します。

add_filter( 'woocommerce_gateway_description', function( $description, $gateway_id ) {
    if ( get_locale() === 'ja' ) {
        return 'こちらは日本語の説明です。';
    }
    return $description;
});

サンプルコード5: すべてのゲートウェイの説明を一括変更

このコードは、すべての決済ゲートウェイに対して一括で説明を変更します。

add_filter( 'woocommerce_gateway_description', function( $description, $gateway_id ) {
    return 'すべての決済が簡単に行えます。';
});

これらのサンプルコードは、woocommerce_gateway_description フィルタを使用して、WooCommerceの決済ゲートウェイの説明文をカスタマイズする様々な方法を示しています。

概要