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

概要

woocommerce_backordered_item_meta_nameフィルタは、WooCommerceにおいてバックオーダーアイテムのメタデータの名前を変更またはカスタマイズするために使用されるフックです。このフィルタは、出荷予定日や在庫状況など、顧客に表示される情報を調整する際によく使用されます。以下は、woocommerce_backordered_item_meta_nameフィルタがよく使われる機能例です：

バックオーダー商品の説明をカスタマイズする
商品のリードタイムを表示する
バックオーダーの優先度を示すラベルを追加する
バックオーダー商品のステータスを変える
ユーザー向けにより親しみやすいメッセージを表示する
バックオーダーの数量を強調表示する

構文

add_filter( 'woocommerce_backordered_item_meta_name', 'custom_function_name', 10, 2 );

パラメータ

woocommerce_backordered_item_meta_name: フィルタの名前。
custom_function_name: ユーザー定義のコールバック関数名。
引数:
- $item_name (string): 商品名。
- $item (WC_Order_Item): 商品オブジェクト。

戻り値

変更またはカスタマイズされた商品名 (string)。

使用可能なプラグインおよびバージョン

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_backordered_item_meta_name', 'add_prefix_to_backordered_item_name', 10, 2 );

function add_prefix_to_backordered_item_name( $item_name, $item ) {
    return 'バックオーダー: ' . $item_name;
}

このコードは、バックオーダー商品の名前の前に「バックオーダー: 」というプレフィックスを追加します。

サンプル2: バックオーダー商品のリードタイムを表示

add_filter( 'woocommerce_backordered_item_meta_name', 'add_lead_time_to_backordered_item_name', 10, 2 );

function add_lead_time_to_backordered_item_name( $item_name, $item ) {
    return $item_name . ' (リードタイム: 2〜3週間)';
}

このコードは、バックオーダー商品の名称にリードタイムの情報を追加します。

サンプル3: バックオーダーの商品名を条件に基づいて変更

add_filter( 'woocommerce_backordered_item_meta_name', 'conditional_backordered_item_name_change', 10, 2 );

function conditional_backordered_item_name_change( $item_name, $item ) {
    if ( $item->get_quantity() > 5 ) {
        return $item_name . ' - 人気商品!';
    }
    return $item_name;
}

このコードは、バックオーダー商品の数量に基づいて商品名に「人気商品!」のラベルを追加します。

サンプル4: バックオーダー商品の数量を強調表示

add_filter( 'woocommerce_backordered_item_meta_name', 'highlight_backordered_item_quantity', 10, 2 );

function highlight_backordered_item_quantity( $item_name, $item ) {
    return $item_name . ' [数量: ' . $item->get_quantity() . ']';
}

このコードは、バックオーダー商品の名称にその数量を強調表示して追加します。

サンプル5: バックオーダー商品のステータスを示す

add_filter( 'woocommerce_backordered_item_meta_name', 'show_backorder_status', 10, 2 );

function show_backorder_status( $item_name, $item ) {
    return $item_name . ' (ステータス: 保留中)';
}

このコードは、バックオーダー商品の名称にステータス「保留中」を追加します。

概要

構文