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

概要

woocommerce_gateway_title フィルタは、WooCommerceでの支払いゲートウェイのタイトルを変更するために使用されます。このフィルタを利用することで、オンラインショップオーナーは顧客に提供する支払いオプションの名称をカスタマイズできます。特に、ユーザーエクスペリエンスを向上させるために、新たなタイトルを設定したり、特定のコンテキストに応じてタイトルを変更する際に役立ちます。

よく使われる機能

支払いゲートウェイの名称をローカライズする
プラットフォームに合ったフレンドリーな名称に変更する
特定のプロモーションやキャンペーンに合わせてタイトルを設定する
ブランドコンセプトに合わせた名称を適用する
ゲートウェイの説明を含めたタイトルに変更する
不要な情報を削除し、シンプルに保つ

フィルタの概要

構文: add_filter('woocommerce_gateway_title', 'callback_function', 10, 2);
パラメータ:
- $title: 現在のゲートウェイタイトル
- $id: ゲートウェイのID
戻り値: 変更されたタイトル
WooCommerceのバージョン: 2.1.0以降
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_title', 'custom_gateway_title', 10, 2);
function custom_gateway_title($title, $id) {
    if ($id === 'stripe') {
        return 'クレジットカード決済';
    }
    return $title;
}

このコードは、Stripe支払いゲートウェイのタイトルを「クレジットカード決済」に変更します。

引用元

サンプル2: 特定の条件に基づいてタイトルを変更

add_filter('woocommerce_gateway_title', 'conditional_gateway_title', 10, 2);
function conditional_gateway_title($title, $id) {
    if (is_cart() && $id === 'paypal') {
        return 'PayPalでお支払い';
    }
    return $title;
}

このコードは、カートページにいる時のみPayPalのタイトルを変更します。

引用元

サンプル3: すべてのゲートウェイのタイトルにプレフィックスを追加

add_filter('woocommerce_gateway_title', 'prefix_gateway_title', 10, 2);
function prefix_gateway_title($title, $id) {
    return 'お支払い方法: ' . $title;
}

このコードにより、すべてのゲートウェイタイトルの前に「お支払い方法: 」が追加されます。

引用元

サンプル4: タイトルにアイコンを追加

add_filter('woocommerce_gateway_title', 'icon_gateway_title', 10, 2);
function icon_gateway_title($title, $id) {
    if ($id === 'bank_transfer') {
        return '🏦 銀行振込';
    }
    return $title;
}

このコードは、銀行振込のタイトルにアイコンを追加しています。

引用元

サンプル5: 各ゲートウェイにカスタムメッセージを追加

add_filter('woocommerce_gateway_title', 'custom_message_gateway_title', 10, 2);
function custom_message_gateway_title($title, $id) {
    $custom_message = ' - 安全で簡単に利用可能';
    return $title . $custom_message;
}

このコードは、すべての支払いゲートウェイタイトルの後にカスタムメッセージを追加します。

引用元

概要