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

概要

woocommerce_pay_order_button_text フィルタは、WooCommerceプラグイン内で注文を支払うボタンのテキストを変更するために使用されます。このフィルタを用いることで、ユーザーエクスペリエンスを向上させたり、特定のキャンペーンに合わせてボタンのラベルを変更したりすることができます。具体的には、以下のような機能を実装する際によく使用されます。

ボタンテキストをカスタムメッセージに変更
特定の条件に基づいてボタンテキストを動的に変更
言語設定に応じたテキストの翻訳
特定の製品やサービスに合わせたテキスト変更
シーズンやイベントに合わせたマーケティング用の文言変更
ユーザーの動機付けを促進するためのテキスト変更

フィルタの構文は次の通りです。

add_filter( 'woocommerce_pay_order_button_text', 'カスタム関数名');

パラメータ:
– woocommerce_pay_order_button_text: 支払いボタンのテキスト。
– 変更されると新しいテキストが戻り値として返されます。

戻り値: 変更後のボタンテキスト（文字列）。

このフィルタは、WooCommerceのバージョン5.0以降、WordPressのバージョン5.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_pay_order_button_text', 'change_pay_button_text' );

function change_pay_button_text( $text ) {
    return '今すぐお支払い';
}

このコードは、WooCommerceの支払ボタンのテキストを「今すぐお支払い」に変更します。

サンプル2: 特定の製品に基づいたボタンテキスト

add_filter( 'woocommerce_pay_order_button_text', 'conditional_pay_button_text' );

function conditional_pay_button_text( $text ) {
    if ( is_product( 123 ) ) { // 製品ID123に対して
        return '特別オファーを受け取る';
    }
    return $text;
}

このコードは、製品IDが123の場合に支払ボタンのテキストを「特別オファーを受け取る」に変更します。

サンプル3: セール中のテキスト変更

add_filter( 'woocommerce_pay_order_button_text', 'discount_sale_button_text' );

function discount_sale_button_text( $text ) {
    if ( is_sale() ) { // セール中かどうかチェック
        return 'セール価格でお支払い';
    }
    return $text;
}

このコードは、セール中の時に支払ボタンのテキストを「セール価格でお支払い」に変更します。

サンプル4: ユーザーのロールによるテキスト変更

add_filter( 'woocommerce_pay_order_button_text', 'user_role_based_text' );

function user_role_based_text( $text ) {
    if ( current_user_can( 'administrator' ) ) {
        return '管理者としてお支払い';
    }
    return $text;
}

このコードは、現在のユーザーが管理者の場合に支払ボタンのテキストを「管理者としてお支払い」に変更します。

サンプル5: 翻訳用テキスト

add_filter( 'woocommerce_pay_order_button_text', 'translate_button_text' );

function translate_button_text( $text ) {
    return __( '安全にお支払い', 'woocommerce' );
}

このコードは、支払ボタンのテキストを国際化に対応した「安全にお支払い」に変更します。

概要