プラグインWooCommerceのwoocommerce_before_single_product_summaryアクションの使用方法・解説

概要

woocommerce_before_single_product_summary アクションフックは、WooCommerceの商品詳細ページで、商品情報の表示前に特定のコードを実行するために使用されます。このアクションは、商品が表示される前に親カスタマイズや追加の情報を挿入することができるため、さまざまな用途で利用されます。よく使われる機能としては、以下の6つがあります。

商品ギャラリーの追加
カスタムメッセージの表示
チェックアウトボタンのカスタマイズ
商品の特別オファーやプロモーションの表示
ソーシャルメディア共有ボタンの追加
カスタムHTMLやJavaScriptの挿入

構文

add_action( 'woocommerce_before_single_product_summary', 'custom_function_name', priority );

パラメータ

custom_function_name: 作成する関数名
priority: フックの実行順序（デフォルトは10）

戻り値

このアクションには戻り値がありません。

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

WooCommerce: 3.0以上
WordPress: 4.0以上

サンプルコード

サンプルコード1: 商品のカスタムメッセージを追加

add_action( 'woocommerce_before_single_product_summary', 'add_custom_message' );

function add_custom_message() {
    echo '<div class="custom-message">特別オファー: この商品を購入すると10%オフ！</div>';
}

このコードは、商品詳細ページの概要セクションの前にカスタムメッセージを表示します。

サンプルコード2: 商品ギャラリーのカスタマイズ

add_action( 'woocommerce_before_single_product_summary', 'custom_gallery', 5 );

function custom_gallery() {
    // 商品のギャラリーをカスタマイズするコード
    echo '<div class="custom-gallery">ここにカスタムギャラリーを追加できます。</div>';
}

このコードは、商品のギャラリーセクションの前にカスタムギャラリーのプレースホルダーを追加します。

サンプルコード3: ソーシャルメディア共有ボタンを追加

add_action( 'woocommerce_before_single_product_summary', 'add_social_sharing_buttons' );

function add_social_sharing_buttons() {
    echo '<div class="social-sharing">ソーシャル共有ボタンの HTML コードここに</div>';
}

このコードは、シングルプロダクトページでソーシャルメディア共有ボタンを表示します。

サンプルコード4: カスタムHTMLを挿入

add_action( 'woocommerce_before_single_product_summary', 'insert_custom_html' );

function insert_custom_html() {
    echo '<div class="custom-html">ここにカスタム HTML を挿入できます。</div>';
}

このコードは、商品詳細ページにカスタムHTMLを挿入するためのサンプルです。

サンプルコード5: チェックアウトボタンをカスタマイズ

add_action( 'woocommerce_before_single_product_summary', 'custom_checkout_button' );

function custom_checkout_button() {
    echo '<a href="' . wc_get_checkout_url() . '" class="button">今すぐ購入</a>';
}

このコードは、シングルプロダクトページにカスタマイズされたチェックアウトボタンを表示します。

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

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

このテーブルは、woocommerce_before_single_product_summary アクションが各フックで使用されるかどうかを示しています。

概要

構文