プラグインWooCommerceのwoocommerce_product_export_$THIS->EXPORT_TYPE_default_columnsフィルタの使用方法・解説

概要

woocommerce_product_export_$THIS->EXPORT_TYPE_default_columns フィルタは、WooCommerce で商品エクスポート機能を実装する際に、エクスポートするカラムをカスタマイズするのに使用されます。このフィルタを利用することで、デフォルトのエクスポート項目を変更したり、追加したりすることができます。一般的に、以下のような機能を実装する際に利用されます。

1. 特定のプロダクト情報をエクスポートに含める
2. エクスポートカラムの順序を変更
3. 不要なカラムを削除
4. カスタムフィールドを追加
5. ユーザーによるカスタマイズエクスポート設定
6. エクスポートファイル形式（CSV, XLSXなど）の変更

構文

add_filter('woocommerce_product_export_$THIS->EXPORT_TYPE_default_columns', 'custom_function_name', 10, 1);

パラメータ

• $columns (array) — デフォルトのカラム名の配列。

戻り値

• (array) — カスタマイズ後のカラム名の配列。

WooCommerce のバージョン

このフィルタは WooCommerce 3.0.0 以降で使用可能です。

WordPress のバージョン

このフィルタは 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: デフォルトのカラムから「SKU」を追加

add_filter('woocommerce_product_export_default_columns', 'add_sku_to_export_columns', 10, 1);

function add_sku_to_export_columns($columns) {
    $columns['sku'] = __('SKU', 'woocommerce');
    return $columns;
}

このコードは、商品エクスポート時に「SKU」カラムをデフォルトのカラムに追加します。

出典: WooCommerce公式ドキュメント

サンプルコード2: 不要なカラムを削除

add_filter('woocommerce_product_export_default_columns', 'remove_unwanted_columns', 10, 1);

function remove_unwanted_columns($columns) {
    unset($columns['price']); // 価格カラムを削除
    return $columns;
}

このコードは、商品エクスポート時に「価格」カラムを削除します。

出典: WooCommerce公式ドキュメント

サンプルコード3: エクスポートカラムの順序を変更

add_filter('woocommerce_product_export_default_columns', 'reorder_export_columns', 10, 1);

function reorder_export_columns($columns) {
    $new_order = array('name', 'sku', 'stock'); // 新しい順序
    return array_merge(array_flip($new_order), $columns);
}

このコードは、商品エクスポート時のカラムの順序を「名前」、「SKU」、「在庫」に変更します。

出典: WooCommerce公式ドキュメント

サンプルコード4: カスタムフィールドを追加

add_filter('woocommerce_product_export_default_columns', 'add_custom_field_to_export', 10, 1);

function add_custom_field_to_export($columns) {
    $columns['custom_field'] = __('Custom Field', 'woocommerce');
    return $columns;
}

このコードは、商品エクスポート時にカスタムフィールドを追加します。

出典: WooCommerce公式ドキュメント

サンプルコード5: 片道カラムを非表示にする

add_filter('woocommerce_product_export_default_columns', 'hide_column_in_export', 10, 1);

function hide_column_in_export($columns) {
    if (isset($columns['weight'])) {
        unset($columns['weight']); // 重量カラムを非表示
    }
    return $columns;
}

このコードは、エクスポート時に重量カラムを非表示にします。

出典: WooCommerce公式ドキュメント