概要
woocommerce_review_before アクションフックは、WooCommerce の商品レビューが表示される前に実行されるフックです。主に以下のような機能を実装する際に利用されます。
- レビューフォームの前にカスタムメッセージを表示する
- カスタムスタイルやクラスをレビューセクションに適用する
- 他のプラグインや機能との統合のための設置
- ユーザーデータやインタラクションを取得する
- ソーシャルシェアボタンを追加する
- カスタムトラッキングコードを挿入する
構文
do_action( 'woocommerce_review_before', $comment );
パラメータ
$comment: 表示されるレビューのコメントオブジェクト
戻り値
戻り値はなく、出力を変更するために使用されます。
使用可能なプラグインおよびバージョン
- WooCommerce バージョン: 2.1.0以降
- WordPress バージョン: 4.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_action( 'woocommerce_review_before', 'custom_review_message' );
function custom_review_message( $comment ) {
echo '<p>このレビューにコメントを追加してください。</p>';
}
このコードは、レビューフォームの前にカスタムメッセージを表示します。特にユーザーに追加のコメントを促すために役立ちます。
サンプルコード2:
add_action( 'woocommerce_review_before', 'add_custom_class_to_review' );
function add_custom_class_to_review( $comment ) {
echo '<div class="custom-review-container">';
}
このコードは、レビューセクションにカスタムクラスを持つ <div> を追加します。これによりスタイルをカスタマイズできます。
サンプルコード3:
add_action( 'woocommerce_review_before', 'insert_tracking_code' );
function insert_tracking_code( $comment ) {
echo '<script>console.log("レビュー表示前です");</script>';
}
このコードは、レビューが表示される前にコンソールログを出力するトラッキング用のスクリプトを挿入します。
サンプルコード4:
add_action( 'woocommerce_review_before', 'display_social_share_buttons' );
function display_social_share_buttons( $comment ) {
echo '<button class="share-button">シェア</button>';
}
このコードは、レビューの前にソーシャルシェアボタンを追加します。ユーザーにレビューを共有させることができます。
サンプルコード5:
add_action( 'woocommerce_review_before', 'add_custom_review_html' );
function add_custom_review_html( $comment ) {
echo '<div class="extra-info">このレビューはユーザーによって評価されています。</div>';
}
このコードは、レビューの前に追加の情報を表示するカスタム HTML を挿入します。これにより、ユーザーがレビューの重要性を理解できます。