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

2025年2月22日 WooCommerce、プラグイン

概要

woocommerce_refund_restock_noteフィルタは、WooCommerceでの返品時にリストックされた商品に関するノートをカスタマイズするために使用されます。このフィルタを使用することで、リストック通知の内容を変更したり、特定のビジネスロジックを適用したりすることができます。一般的には、以下のような機能を実装する際によく使われます。

返品理由に応じたメッセージの追加
リストックされた商品の状態を明記
顧客への通知内容を改善
特定のプロモーションの表示
商品カタログの更新情報を通知
返品処理に関する内部メモを追加

フィルタの構文は以下の通りです。

apply_filters( 'woocommerce_refund_restock_note', $note );

パラメータ

$note: リストックノートの内容 (文字列)

戻り値

修正されたノート (文字列)

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

WooCommerce バージョン: 4.0以上
WordPress バージョン: 5.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_refund_restock_note', 'add_refund_reason_to_note' );

function add_refund_reason_to_note( $note ) {
    $reason = get_post_meta( $order_id, '_refund_reason', true );
    if ( $reason ) {
        $note .= ' (理由: ' . esc_html( $reason ) . ')';
    }
    return $note;
}

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

サンプルコード2: 特定のプロモーションメッセージを追加

このコードは、特定の商品の返品時にプロモーションメッセージをリストックノートに追加します。

add_filter( 'woocommerce_refund_restock_note', 'add_promotion_message' );

function add_promotion_message( $note, $order_id, $item_id ) {
    $product_id = get_post_meta( $item_id, '_product_id', true );

    if ( $product_id == 123 ) { // 特定の製品ID
        $note .= ' 詳細については、次回の購入時に10%オフになります！';
    }
    return $note;
}

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

サンプルコード3: 商品の状態を追加する

このコードは、返品された商品の状態（例: 新品、開封済み）をノートに追加します。

add_filter( 'woocommerce_refund_restock_note', 'add_product_condition_to_note' );

function add_product_condition_to_note( $note, $order_id, $item_id ) {
    $status = get_post_meta( $item_id, '_product_condition', true );
    $note .= ' 商品状態: ' . esc_html( $status );
    return $note;
}

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

サンプルコード4: 内部メモを追加する

このサンプルは、返品処理に関する内部メモをリストックノートに追加します。

add_filter( 'woocommerce_refund_restock_note', 'add_internal_note' );

function add_internal_note( $note ) {
    $note .= ' (内部メモ: 返品処理のための確認事項)';
    return $note;
}

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

サンプルコード5: カスタムフィールドからの情報を追加する

このコードは、カスタムフィールドからの情報をリストックノートに追加します。

add_filter( 'woocommerce_refund_restock_note', 'add_custom_field_info' );

function add_custom_field_info( $note, $order_id, $item_id ) {
    $custom_info = get_post_meta( $item_id, '_custom_field', true );
    if ( $custom_info ) {
        $note .= ' カスタム情報: ' . esc_html( $custom_info );
    }
    return $note;
}

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

この関数について質問するコメントをキャンセル