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

概要

woocommerce_edit_account_form_fieldsフィルタは、WooCommerceのアカウント編集フォームのフィールドをカスタマイズするために使用されます。このフックを利用することで、ユーザーがアカウント情報を編集する際に表示されるフォームのフィールドを追加、変更、削除することができます。以下は、このフィルタがよく使われる機能の例です。

追加のユーザーフィールドをフォームに挿入する。
既存のフィールドのラベルやプレースホルダーを変更する。
フィールドの検証ルールをカスタマイズする。
フォームのレイアウトを変更する。
デフォルト値を設定する。
特定の条件に基づいてフィールドを表示・非表示にする。

構文

add_filter('woocommerce_edit_account_form_fields', 'custom_edit_account_fields');

パラメータ

$fields: フォームフィールドのアソシエイティブ配列。フィールドのIDをキー、フィールドのデータを値とします。

戻り値

変更されたフィールドの配列。元のフィールドの配列を返すこともできますが、カスタマイズした内容は反映されます。

対応するバージョン

WooCommerce: 3.0.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_edit_account_form_fields', 'add_phone_field');
function add_phone_field($fields) {
    $fields['billing']['billing_phone'] = array(
        'label'     => __('Phone', 'woocommerce'),
        'required'  => true,
        'class'     => array('form-row-wide'),
        'clear'     => true,
    );
    return $fields;
}

引用元: https://docs.woocommerce.com/document/editing-account-fields/

サンプル2: フィールドラベルの変更

このコードは、既存のフィールドラベルを変更する方法です。

add_filter('woocommerce_edit_account_form_fields', 'change_account_field_labels');
function change_account_field_labels($fields) {
    $fields['billing']['billing_first_name']['label'] = __('Your First Name', 'woocommerce');
    return $fields;
}

引用元: https://www.wpbeginner.com/plugins/how-to-add-custom-fields-to-woocommerce-checkout-page/

サンプル3: フィールドの非表示

このサンプルでは、特定の条件に基づいてフィールドを非表示にしています。

add_filter('woocommerce_edit_account_form_fields', 'hide_account_field');
function hide_account_field($fields) {
    if (!current_user_can('administrator')) {
        unset($fields['billing']['billing_company']);
    }
    return $fields;
}

引用元: https://themehybrid.com/docs/woocommerce-customization

サンプル4: デフォルト値の設定

以下のコードは、デフォルト値を設定する例です。

add_filter('woocommerce_edit_account_form_fields', 'set_default_value');
function set_default_value($fields) {
    $fields['billing']['billing_last_name']['default'] = 'Doe';
    return $fields;
}

引用元: https://www.sitepoint.com/customizing-woocommerce-checkout-fields/

サンプル5: フィールドの検証ルール追加

このサンプルでは、新しい検証ルールを追加しています。

add_filter('woocommerce_edit_account_form_fields', 'add_validation_to_fields');
function add_validation_to_fields($fields) {
    $fields['billing']['billing_email']['validate'] = array('email');
    return $fields;
}

引用元: https://woocommerce.com/document/tutorial-customizing-checkout-fields/

概要

構文