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

概要

woocommerce_account_$KEY_endpointアクションは、WooCommerceのアカウントページにカスタムエンドポイントを追加する際に使用されます。具体的には、ユーザーが自分のアカウント情報を管理するための特定のセクションを作成するために役立ちます。このアクションを使用すると、WooCommerceのデフォルト機能を拡張し、ユーザーエクスペリエンスを向上させることができます。

よく使われる機能の例：
1. ユーザーの購入履歴の表示
2. ユーザーの定期購読の管理
3. プロフィール情報の編集セクションの追加
4. カスタム通知の表示
5. ユーザーが特定のサービスへのアクセスを管理できる機能
6. 新しい機能の紹介やプロモーションを行うためのスペースの提供

構文

add_action( 'woocommerce_account_$KEY_endpoint', 'your_function_name' );

パラメータ

$KEY: エンドポイントのキー名（任意の文字列）
your_function_name: 実行する関数の名前

戻り値

特になし。実行された関数の処理が行われる。

使用可能なプラグインのバージョンとワードプレスのバージョン

WooCommerce: 3.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_account_purchase_history_endpoint', 'display_purchase_history' );

function display_purchase_history() {
    echo '<h3>購入履歴</h3>';
    // 購入履歴の取得と表示ロジックをここに記述
}

引用元: https://woocommerce.com/document/woocommerce-account-page/

サンプル 2: プロフィール情報の編集

このコードは、ユーザーが自分のプロフィール情報を編集できるセクションを作成します。

add_action( 'woocommerce_account_profile_endpoint', 'edit_profile_info' );

function edit_profile_info() {
    echo '<h3>プロフィール情報の編集</h3>';
    // フォームや編集ロジックをここに記述
}

引用元: https://woocommerce.com/document/custom-endpoints-woocommerce-account/

サンプル 3: 定期購読の管理

このコードは、ユーザーが自分の定期購読を管理できるためのエンドポイントを作成します。

add_action( 'woocommerce_account_subscriptions_endpoint', 'manage_subscriptions' );

function manage_subscriptions() {
    echo '<h3>定期購読の管理</h3>';
    // 定期購読のリストを表示するロジックをここに記述
}

引用元: https://woocommerce.com/document/woocommerce-subscriptions/

サンプル 4: カスタム通知の表示

このコードは、ユーザーに特定の通知を表示するためのエンドポイントを作成します。

add_action( 'woocommerce_account_notifications_endpoint', 'display_notifications' );

function display_notifications() {
    echo '<h3>通知</h3>';
    // 通知内容を取得して表示するロジックをここに記述
}

引用元: https://woocommerce.com/document/create-custom-endpoints-woocommerce/

サンプル 5: プロモーション情報の表示

このコードは、特定のプロモーション情報を表示するエンドポイントを作成します。

add_action( 'woocommerce_account_promotions_endpoint', 'show_promotions' );

function show_promotions() {
    echo '<h3>プロモーションお知らせ</h3>';
    // プロモーション内容を表示するロジックをここに記述
}

引用元: https://woocommerce.com/document/adding-custom-content-to-my-account-page/

概要

構文