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

概要

woocommerce_short_description フィルタは、WooCommerceの商品ページにおける短い説明文を変更するために使用されます。このフィルタを使用することによって、デフォルトの短い説明文をカスタマイズし、特定のニーズに応じて表示内容を調整できます。このフィルタは、特に以下のような機能を実装する際によく使用されます：

1. 商品の短い説明にHTMLタグを追加
2. 特定の条件に基づいて短い説明の内容を動的に変更
3. 商品のデータを外部ソースから取得し表示
4. ショートコードを用いて複雑なコンテンツを表示
5. 複数の言語に対応するための説明文の翻訳
6. マーケティング用のアピールポイントやキャンペーン情報の追加

構文

add_filter('woocommerce_short_description', 'your_custom_function');

パラメータ

• $post_excerpt: 商品の短い説明文。

戻り値

• 変更した短い説明文。

互換性

• WooCommerceバージョン: すべての最新版
• WordPressバージョン: すべての最新版

サンプルコード

1. HTMLタグを追加するサンプル
   商品の短い説明にHTMLの強調タグを追加するサンプルコードです。

   add_filter('woocommerce_short_description', function($post_excerpt) {
      return '<strong>' . $post_excerpt . '</strong>';
   });
   

   引用元: https://developer.wordpress.org/reference/functions/add_filter/

2. 条件に応じて短い説明を変更するサンプル
   特定の条件に基づいて短い説明の内容を変更するサンプルです。

   add_filter('woocommerce_short_description', function($post_excerpt) {
      if (is_single('your-product-slug')) {
          return '特別オファー: ' . $post_excerpt;
      }
      return $post_excerpt;
   });
   

   引用元: https://developer.wordpress.org/reference/functions/add_filter/

3. 外部データソースから情報を取得して表示するサンプル
   APIから商品情報を取得してショートディスクリプションに追加するサンプルです。

   add_filter('woocommerce_short_description', function($post_excerpt) {
      $response = wp_remote_get('https://api.example.com/product-details');
      if (is_wp_error($response)) {
          return $post_excerpt;
      }
      $data = json_decode(wp_remote_retrieve_body($response), true);
      return $post_excerpt . '<br>詳しくはこちら: ' . esc_html($data['details']);
   });
   

   引用元: https://developer.wordpress.org/reference/functions/add_filter/

4. ショートコードを使用するサンプル
   ショートコードを使って商品説明にカスタムコンテンツを追加するサンプルです。

   add_filter('woocommerce_short_description', function($post_excerpt) {
      return $post_excerpt . do_shortcode('[your_custom_shortcode]');
   });
   

   引用元: https://developer.wordpress.org/reference/functions/add_filter/

5. 多言語対応サンプル
   多言語サイトで商品の短い説明を翻訳するサンプルです。

   add_filter('woocommerce_short_description', function($post_excerpt) {
      if (ICL_LANGUAGE_CODE == 'fr') {
          return 'Version française: ' . $post_excerpt;
      }
      return $post_excerpt;
   });
   

   引用元: https://developer.wordpress.org/reference/functions/add_filter/

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