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

概要

woocommerce_rate_labelフィルタは、WooCommerceの配送オプションのレートラベルをカスタマイズするために使用されます。このフィルタを使うことで、配送方法の名称や表示文言を変更することができ、ユーザーにとってよりわかりやすく、魅力的な選択肢を提供できます。

このフィルタは、以下のような機能を実装する際によく使われます：

1. 配送方法の名称をローカライズする。
2. 特定の条件に基づいて配送オプションの名称を変更する。
3. プロモーションや割引に関連するメッセージを追加する。
4. 環境に優しい配送オプションの名称を変更する。
5. 配送業者のブランド名を強調表示する。
6. 配送オプションに関連する説明を追加する。

構文

add_filter('woocommerce_rate_label', 'my_custom_rate_label', 10, 2);

パラメータ

• woocommerce_rate_label: フィルターフックの名前。
• my_custom_rate_label: カスタムコールバック関数の名前。
• 10: プライオリティ（デフォルト）。
• 2: 引数の数（rateおよびmethod）。

戻り値

• 修正された配送オプションのレートラベル（文字列）。

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

• WooCommerceバージョン4.0.0以降。

ワードプレスのバージョン

• WordPressバージョン5.0.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_rate_label', 'change_shipping_method_label', 10, 2);
   function change_shipping_method_label($label, $method) {
      if ($method->id === 'flat_rate:1') {
          $label = '特急配送';
      }
      return $label;
   }
   

   このサンプルコードは、特定の配送方法（フラットレート）に対して、配送の名称を「特急配送」に変更します。

2. 条件に基づいたラベルのカスタマイズ

   add_filter('woocommerce_rate_label', 'conditional_rate_label_change', 10, 2);
   function conditional_rate_label_change($label, $method) {
      if ( WC()->cart->subtotal > 100 ) {
          $label .= '（送料無料）';
      }
      return $label;
   }
   

   このコードは、カートの合計が100ドルを超える場合に「（送料無料）」という文言を追加します。

3. プロモーション告知を追加

   add_filter('woocommerce_rate_label', 'add_promotion_to_label', 10, 2);
   function add_promotion_to_label($label, $method) {
      return $label . ' - 今なら20%オフ！';
   }
   

   プロモーションを告知する文言を配送方法の名称に追加する例です。

4. エコ配送オプション名称の変更

   add_filter('woocommerce_rate_label', 'eco_friendly_shipping_label', 10, 2);
   function eco_friendly_shipping_label($label, $method) {
      if ($method->id === 'eco_shipping') {
          $label = 'エコ配送（環境配慮型）';
      }
      return $label;
   }
   

   環境に配慮した配送方法の名称を変更する例です。

5. 配送業者名を強調

   add_filter('woocommerce_rate_label', 'highlight_carrier_name', 10, 2);
   function highlight_carrier_name($label, $method) {
      return '🚚 ' . $label . ' - 配送業者: XYZ配送';
   }
   

   配送業者名を強調表示するためにアイコンを追加する例です。

引用元のページは、WooCommerceおよびWordPressの公式ドキュメントやコミュニティフォーラムを利用することをお勧めします。