プラグインWooCommerceのwoocommerce_product_object_updated_propsアクションの使用方法・解説

概要

woocommerce_product_object_updated_props は、WooCommerce の特定の商品オブジェクトが更新された際にトリガーされるアクションフックです。このフックは、商品プロパティの変更を検知したときにカスタムな処理を行う際に便利です。主に以下のような機能を実装する際に利用されることが多いです。

商品の在庫状況の自動更新
特定のカスタムフィールドの値を基にした通知機能
商品の更新に伴う外部APIとの連携
商品の更新情報をログファイルに記録
お客様へのメール通知
データベース内の商品情報の再計算

構文

do_action( 'woocommerce_product_object_updated_props', $product, $updated_props );

パラメータ

$product (WC_Product): 更新された商品オブジェクト。
$updated_props (array): 更新された商品プロパティの配列。

戻り値

このアクションフック自体は戻り値を返しませんが、その他の関数の戻り値として処理結果を取得できます。

使用可能なプラグインおよびワードプレスのバージョン

WooCommerce バージョン: 3.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_action( 'woocommerce_product_object_updated_props', 'log_product_updates', 10, 2 );

function log_product_updates( $product, $updated_props ) {
    $log_file = __DIR__ . '/product_updates.log';
    file_put_contents( $log_file, "Product ID: {$product->get_id()} updated with: " . print_r( $updated_props, true ), FILE_APPEND );
}

このサンプルコードは、商品が更新されるたびに、その商品IDと更新されたプロパティの情報をログファイルに追記します。

サンプルコード 2: 在庫状況に基づく通知

add_action( 'woocommerce_product_object_updated_props', 'notify_out_of_stock', 10, 2 );

function notify_out_of_stock( $product, $updated_props ) {
    if ( isset( $updated_props['stock_status'] ) && 'outofstock' === $updated_props['stock_status'] ) {
        // メール通知のロジックを記述
        wp_mail( 'admin@example.com', 'Out of Stock Notification', 'Product ID: ' . $product->get_id() . ' is now out of stock.' );
    }
}

このコードは、商品が「在庫切れ」に設定された場合に管理者にメール通知を送ります。

サンプルコード 3: 外部APIへのデータ送信

add_action( 'woocommerce_product_object_updated_props', 'send_product_update_to_api', 10, 2 );

function send_product_update_to_api( $product, $updated_props ) {
    // GET API URL
    $api_url = 'https://example.com/api/update-product';
    $data = array(
        'product_id' => $product->get_id(),
        'updated_props' => $updated_props,
    );

    wp_remote_post( $api_url, array(
        'method'    => 'POST',
        'body'      => json_encode( $data ),
        'headers'   => array( 'Content-Type' => 'application/json' ),
    ) );
}

このサンプルは、商品が更新されたときに外部APIにリクエストを送信します。

サンプルコード 4: カスタムフィールドの値を再計算

add_action( 'woocommerce_product_object_updated_props', 'recalculate_custom_field', 10, 2 );

function recalculate_custom_field( $product, $updated_props ) {
    if ( isset( $updated_props['regular_price'] ) ) {
        $new_value = $product->get_regular_price() * 1.1; // 魅力的なURLのための計算（例）
        $product->update_meta_data( 'custom_field', $new_value );
        $product->save();
    }
}

このコードは、商品の通常価格が更新された場合にカスタムフィールドの値を再計算し、その値を保存します。

サンプルコード 5: プロパティ更新のカスタム処理

add_action( 'woocommerce_product_object_updated_props', 'custom_product_update_handler', 10, 2 );

function custom_product_update_handler( $product, $updated_props ) {
    // 特定のプロパティが更新された場合の処理
    if ( isset( $updated_props['sale_price'] ) ) {
        // セール価格に関する特別な処理を実施
        update_option( 'last_sale_product', $product->get_id() );
    }
}

このサンプルは、商品にセール価格の設定がされると、最後にセール設定された商品のIDをオプションに保存します。

概要

構文