プラグインWooCommerceのwoocommerce_is_order_received_page関数の使用方法・解説

概要

woocommerce_is_order_received_page 関数は、WooCommerce プラグインにおいて、注文完了ページかどうかを判断するための関数です。主に以下のような機能を実装する際に使用されます。

1. 注文完了ページでの特別なコンテンツの表示
2. トラッキング用のスクリプトやピクセルの挿入
3. 顧客へのカスタムメッセージの表示
4. 注文完了ページのデザインをカスタマイズ
5. 注文完了時のアクションをトリガーする
6. アフターサービス等のリンクを追加する

構文

woocommerce_is_order_received_page();

パラメータ

この関数にはパラメータはありません。

戻り値

この関数は、ブール値（true または false）を返します。注文完了ページであれば true、そうでなければ false です。

使用可能な WooCommerce バージョン

この関数は WooCommerce 2.3 以降で利用可能です。

使用可能な WordPress バージョン

この関数は 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_thankyou', 'custom_thank_you_message', 10, 1);
function custom_thank_you_message($order_id) {
    if (woocommerce_is_order_received_page()) {
        echo '<p>ご注文ありがとうございます！</p>';
    }
}

このサンプルコードは、注文完了ページに特別なメッセージを表示します。

引用元: https://woocommerce.com/

サンプルコード 2: トラッキングコードの挿入

add_action('wp_footer', 'insert_tracking_code');
function insert_tracking_code() {
    if (woocommerce_is_order_received_page()) {
        echo "<script>/* トラッキングコード */</script>";
    }
}

このコードは、注文完了ページのフッターにトラッキングコードを挿入します。

引用元: https://woocommerce.com/

サンプルコード 3: 注文完了時のアクションをトリガー

add_action('woocommerce_thankyou', 'trigger_custom_action', 10, 1);
function trigger_custom_action($order_id) {
    if (woocommerce_is_order_received_page()) {
        // 特定のアクションや処理を実行
    }
}

このサンプルコードは、注文完了ページにアクセスした際に特定のアクションをトリガーします。

引用元: https://woocommerce.com/

サンプルコード 4: 注文完了ページにカスタムスタイルを適用

add_action('wp_head', 'add_custom_styles');
function add_custom_styles() {
    if (woocommerce_is_order_received_page()) {
        echo '<style>/* カスタムスタイル */</style>';
    }
}

このコードは、注文完了ページに特別なカスタムスタイルを適用します。

引用元: https://woocommerce.com/

サンプルコード 5: 注文完了ページの内容を変更

add_action('woocommerce_thankyou', 'modify_thankyou_page', 15);
function modify_thankyou_page($order_id) {
    if (woocommerce_is_order_received_page()) {
        remove_action('woocommerce_thankyou', 'woocommerce_order_details', 10);
        echo '<div>カスタム内容をここに追加できます。</div>';
    }
}

このサンプルコードは、注文完了ページの既存のコンテンツを変更する方法を示しています。

引用元: https://woocommerce.com/