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

概要

woocommerce_order_item_name フィルタは、WooCommerceで注文アイテムの名前をカスタマイズするために使用されるフックです。このフィルタを使用することで、商品名や注文アイテムの表示を動的に変更できます。一般的な使用例としては、以下のようなシナリオが考えられます。

商品名に特定のテキストを追加する
商品名にカスタムHTMLを挿入する
購入数量を商品名に追加する
商品名のフォーマットを変更する
商品のバリエーション情報を表示する
商品名を特定の条件に基づいて翻訳またはローカライズする

構文

add_filter( 'woocommerce_order_item_name', 'your_function_name', 10, 3 );

パラメータ

string $item_name – 注文アイテムの名前。
object $item – 注文アイテムオブジェクト。
object $order – 注文オブジェクト。

戻り値

カスタマイズされたアイテム名。

対応バージョン

WooCommerceバージョン: 既存のすべてのバージョン
WordPressバージョン: 既存のすべてのバージョン

サンプルコード

サンプル1: 商品名に特別なテキストを追加

add_filter( 'woocommerce_order_item_name', 'add_special_text_to_item_name', 10, 3 );
function add_special_text_to_item_name( $item_name, $item, $order ) {
    return $item_name . ' - 特別価格';
}

このコードは、注文アイテム名の末尾に「- 特別価格」というテキストを追加します。

サンプル2: 商品名にカスタムHTMLを挿入

add_filter( 'woocommerce_order_item_name', 'insert_html_in_item_name', 10, 3 );
function insert_html_in_item_name( $item_name, $item, $order ) {
    return '<strong>' . $item_name . '</strong>';
}

この例では、注文アイテム名を強調表示するために<strong>タグを使用しているため、視覚的に目立たせています。

サンプル3: 購入数量を商品名に追加

add_filter( 'woocommerce_order_item_name', 'add_quantity_to_item_name', 10, 3 );
function add_quantity_to_item_name( $item_name, $item, $order ) {
    $quantity = $item->get_quantity();
    return $item_name . ' x ' . $quantity;
}

このコードは、商品名の後に購入数量を「x 数量」という形式で追加します。

サンプル4: 商品名のフォーマットを変更

add_filter( 'woocommerce_order_item_name', 'format_item_name', 10, 3 );
function format_item_name( $item_name, $item, $order ) {
    return '商品名: ' . $item_name;
}

このコードは、商品名の前に「商品名: 」というテキストを追加し、フォーマットを変更しています。

サンプル5: 商品のバリエーション情報を表示

add_filter( 'woocommerce_order_item_name', 'show_variation_info_in_item_name', 10, 3 );
function show_variation_info_in_item_name( $item_name, $item, $order ) {
    if ( isset( $item['variation_id'] ) && $item['variation_id'] > 0 ) {
        $variation = new WC_Product_Variation( $item['variation_id'] );
        return $item_name . ' - ' . $variation->get_attributes_string();
    }
    return $item_name;
}

この例では、商品がバリエーションである場合、そのバリエーションの属性を商品名に追加しています。

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

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

概要

構文