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

概要

woocommerce_product_import_before_process_item アクションフックは、WooCommerceの製品インポートプロセスが商品データを処理する前に呼び出されます。これにより、開発者は商品データを取り込む際のカスタマイズやデータ操作を行うことができます。このフックは、製品のインポート中に特定の操作を実行したい場合に非常に便利です。

このアクションは以下のような場合によく使われます：
1. インポートする商品データのバリデーションを行う。
2. 特定の条件に基づいて商品データを変更する。
3. デフォルトのカテゴリやタグを追加する。
4. 外部データソースからの情報に基づいて商品属性を更新する。
5. メタデータの追加やカスタマイズを行う。
6. インポート中のエラーログを管理する。

構文

do_action( 'woocommerce_product_import_before_process_item', $item, $data );

パラメータ

$item: 現在処理中の商品のアイテム配列。
$data: アイテムのデータ配列。

戻り値

このアクションフックは戻り値を持たず、主に他の機能との統合に使用されます。

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

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_import_before_process_item', 'validate_product_data', 10, 2 );
function validate_product_data( $item, $data ) {
    if ( empty( $data['name'] ) ) {
        // 商品名が空の場合、エラーを発生させる
        throw new Exception( '商品名が必要です。' );
    }
}

このコードは、商品名が空である場合にエラーを発生させるバリデーションを実装しています。

サンプル2: デフォルトカテゴリの追加

add_action( 'woocommerce_product_import_before_process_item', 'set_default_category', 10, 2 );
function set_default_category( $item, $data ) {
    if ( ! isset( $data['category'] ) ) {
        $data['category'] = array( 'デフォルトカテゴリ' );
    }
}

商品データにカテゴリが指定されていない場合にデフォルトのカテゴリを追加します。

サンプル3: メタデータの追加

add_action( 'woocommerce_product_import_before_process_item', 'add_custom_meta', 10, 2 );
function add_custom_meta( $item, $data ) {
    if ( isset( $data['custom_field'] ) ) {
        $item['meta_data']['_custom_field'] = sanitize_text_field( $data['custom_field'] );
    }
}

インポートする商品にカスタムメタデータを追加します。

サンプル4: エラーログの管理

add_action( 'woocommerce_product_import_before_process_item', 'log_import_errors', 10, 2 );
function log_import_errors( $item, $data ) {
    if ( ! is_array( $data ) ) {
        error_log( 'インポートデータが無効です: ' . print_r( $data, true ) );
    }
}

無効なインポートデータが発見された場合にエラーログを記録します。

サンプル5: 商品属性の変更

add_action( 'woocommerce_product_import_before_process_item', 'modify_product_attributes', 10, 2 );
function modify_product_attributes( $item, $data ) {
    if ( isset( $data['attributes'] ) ) {
        foreach ( $data['attributes'] as &$attribute ) {
            $attribute['name'] = strtoupper( $attribute['name'] ); // 属性名を大文字に変換
        }
    }
}

商品属性を処理する際に、属性名を大文字に変換します。

概要

構文