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

概要

woocommerce_saved_payment_methods_listフィルタは、WooCommerceのユーザーが保存した支払い方法のリストをカスタマイズするためのフックです。このフィルタを使用することで、ユーザーインターフェースに表示される保存された支払い方法を変更したり、独自の情報を追加したりすることができます。このフィルタは、以下のような機能を実装する際によく使用されます。

保存されたクレジットカード情報のカスタマイズ
支払い方法の説明を追加
特定の支払い方法の非表示または表示
フロントエンドのデザイン調整
ユーザー向けメッセージの追加
支払い方法にアイコンや画像を追加

構文

add_filter('woocommerce_saved_payment_methods_list', 'your_custom_function');

パラメータ

array $method_list: 保存された支払い方法のリスト。各支払い方法は配列として格納されています。

戻り値

array: 修正された保存された支払い方法のリスト。

使用可能なプラグインWooCommerceのバージョン

5.x以降

WordPressのバージョン

5.x以降

この関数のアクションでの使用可能性

アクション	使用可能性
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_saved_payment_methods_list', 'customize_saved_payment_methods');

function customize_saved_payment_methods($methods) {
    foreach ($methods as $key => $method) {
        $methods[$key]['description'] = 'Your saved method';
    }
    return $methods;
}

このサンプルコードは、保存された支払い方法に独自の説明を追加するものです。

サンプルコード2

add_filter('woocommerce_saved_payment_methods_list', 'remove_specific_payment_method');

function remove_specific_payment_method($methods) {
    foreach ($methods as $key => $method) {
        if ($method['method_id'] === 'specific_method') {
            unset($methods[$key]);
        }
    }
    return $methods;
}

このサンプルコードは、特定の支払い方法をリストから削除します。

サンプルコード3

add_filter('woocommerce_saved_payment_methods_list', 'add_custom_icon');

function add_custom_icon($methods) {
    foreach ($methods as $key => $method) {
        $methods[$key]['icon'] = '<img src="path/to/icon.png" alt="Payment Icon" />';
    }
    return $methods;
}

このサンプルコードは、各支払い方法にカスタムアイコンを追加するものです。

サンプルコード4

add_filter('woocommerce_saved_payment_methods_list', 'add_custom_message');

function add_custom_message($methods) {
    foreach ($methods as $key => $method) {
        if (isset($methods[$key]['description'])) {
            $methods[$key]['description'] .= ' (Custom Message)';
        }
    }
    return $methods;
}

このサンプルコードは、各支払い方法の説明にカスタムメッセージを追加します。

サンプルコード5

add_filter('woocommerce_saved_payment_methods_list', 'reorder_payment_methods');

function reorder_payment_methods($methods) {
    // 新しい順序を定義
    $new_order = ['method_2', 'method_1', 'method_3'];
    $methods = array_merge(array_flip($new_order), $methods);
    return $methods;
}

このサンプルコードは、支払い方法の順序をカスタマイズして新しい順序で表示します。

概要

構文