プラグインWooCommerceのwoocommerce_save_settings_$CURRENT_TAB_$CURRENT_SECTIONアクションの使用方法・解説

概要

woocommerce_save_settings_$CURRENT_TAB_$CURRENT_SECTIONは、WooCommerceの設定が保存されたときに発動するフックです。このアクションは、特定のタブとセクションに関連する設定が保存される際にカスタム処理を実行するために使用されます。主に以下のような機能を実装する際に使用されることが多いです。

設定変更に基づくデータベースの更新。
ステータス変更のトリガー。
カスタムメッセージの表示。
外部APIとの統合。
設定の検証とエラーメッセージの表示。
ログの記録や通知の発行。

構文

add_action( 'woocommerce_save_settings_$CURRENT_TAB_$CURRENT_SECTION', 'your_function' );

パラメータ

$CURRENT_TAB: 現在のタブ名。
$CURRENT_SECTION: 現在のセクション名。

戻り値

このアクションには戻り値はありません。

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

WooCommerce: 3.0.0以上
WordPress: 4.0以上

サンプルコード

サンプル1: カスタム設定をデータベースに保存

このコードは、カスタム設定を保存し、設定が正常に保存されたことを確認する機能を実装しています。

add_action( 'woocommerce_save_settings_general', 'save_custom_setting' );

function save_custom_setting() {
    if ( isset( $_POST['custom_option'] ) ) {
        update_option( 'custom_option', sanitize_text_field( $_POST['custom_option'] ) );
    }
}

引用元: https://developer.woocommerce.com/

サンプル2: 設定変更時のログ記録

この例では、設定が保存されるたびにログを記録する機能を追加しています。

add_action( 'woocommerce_save_settings_tax', 'log_tax_settings_change' );

function log_tax_settings_change() {
    error_log( 'Tax settings updated' );
}

引用元: https://wordpress.org/

サンプル3: エラーチェック

このコードは、特定のフィールドが空でないか確認し、エラーがある場合に警告を表示します。

add_action( 'woocommerce_save_settings_products', 'check_for_empty_field' );

function check_for_empty_field() {
    if ( empty( $_POST['product_field'] ) ) {
        add_settings_error( 'custom_settings_errors', 'empty_field', 'Product field cannot be empty!' );
    }
}

引用元: https://woocommerce.com/

サンプル4: APIとの連携

この例では、設定が変更されると外部APIにデータを送信しています。

add_action( 'woocommerce_save_settings_inventory', 'send_data_to_api' );

function send_data_to_api() {
    $data = array( 'setting_key' => get_option( 'inventory_setting_key' ) );
    wp_remote_post( 'https://api.example.com/update', array( 'body' => $data ) );
}

引用元: https://developer.wordpress.org/

サンプル5: ユーザーへの通知

このコードは、設定が保存された際にユーザーに通知を送信します。

add_action( 'woocommerce_save_settings_shipping', 'send_notification_on_save' );

function send_notification_on_save() {
    add_action( 'admin_notices', function() {
        echo '<div class="notice notice-success is-dismissible"><p>Shipping settings saved successfully.</p></div>';
    });
}

引用元: https://wpbeginner.com/

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

アクション	使用例
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

概要

構文